Scale AI Users API

openapi: 3.2.0
info:
  title: EGP API V4 Users API
  description: This is the parent API for all EGP APIs. If you are looking for the EGP API, please go to https://api.egp.scale.com/docs.
  contact:
    name: Scale Generative AI Platform
    url: https://scale.com/genai-platform
  version: 0.1.0
servers:
- url: https://api.egp.scale.com
security: []
tags:
- name: Users
paths:
  /users/{user_id}:
    get:
      tags:
      - Users
      summary: Get User
      description: Get basic information for a user. The requester must belong to the same organization as the target user and be an admin or manager of an account the target user belongs to.
      operationId: GET-V4-/users/{user_id}
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          title: User Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfoBase'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/users/get-user
  /user-preferences:
    patch:
      tags:
      - Users
      summary: Update user info
      description: Update preferences for the logged in user making this request.
      operationId: PATCH-V4-/user-preferences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPreferencesUpdate'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPreferencesUpdateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/users/update-user-info
  /user-info:
    get:
      tags:
      - Users
      summary: User info
      description: Get basic information for the logged in user making this request including preferences.
      operationId: GET-V4-/user-info
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
      x-source: https://docs.gp.scale.com/reference/v4/users/user-info
components:
  schemas:
    Account:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        organization_id:
          title: Organization Id
          type: string
        status:
          type: string
          title: Status
          description: 'The status of the account: active, disabled, locked'
      type: object
      required:
      - id
      - name
      - status
      title: Account
    IdentityType:
      type: string
      enum:
      - user
      - service_account
      title: IdentityType
    UserInfo:
      properties:
        id:
          type: string
          title: Id
          description: User id
        first_name:
          title: First Name
          description: First name
          type: string
        last_name:
          title: Last Name
          description: Last name
          type: string
        email:
          type: string
          title: Email
          description: E-mail address
        access_profiles:
          items:
            $ref: '#/components/schemas/AccessProfile'
          type: array
          title: Access Profiles
          description: A list of access profiles that the selected user has access to
        organization_id:
          title: Organization Id
          description: The organization ID of the user.
          type: string
        is_organization_admin:
          title: Is Organization Admin
          description: True if the current user is an organization admin.
          type: boolean
        is_deployment_admin:
          title: Is Deployment Admin
          description: True if the current user is a deployment admin.
          type: boolean
        preferences:
          title: Preferences
          description: User preferences that can be stored in the Scale GenAI Platform.
          additionalProperties: true
          type: object
        assumed_access_profile:
          $ref: '#/components/schemas/AccessProfile'
          description: Present if the user has assumed a specific access profile via JWT token.
      type: object
      required:
      - id
      - email
      - access_profiles
      title: UserInfo
    Role:
      type: string
      enum:
      - manager
      - admin
      - editor
      - member
      - labeler
      - disabled
      - invited
      - viewer
      title: Role
    UserPreferencesUpdate:
      properties:
        preferences:
          title: Preferences
          description: User preferences that can be stored in the Scale GenAI Platform.
          additionalProperties: true
          type: object
      type: object
      title: UserPreferencesUpdate
    AccessProfile:
      properties:
        id:
          type: string
          title: Id
          description: Access profile id.
        identity:
          $ref: '#/components/schemas/Identity'
          description: The identity in the access profile.
        role:
          $ref: '#/components/schemas/Role'
          description: The role of the user in the access profile.
        account:
          $ref: '#/components/schemas/Account'
          description: The account in the access profile.
      type: object
      required:
      - id
      - identity
      - role
      - account
      title: AccessProfile
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
          additionalProperties: true
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UserInfoBase:
      properties:
        id:
          type: string
          title: Id
          description: User id
        first_name:
          title: First Name
          description: First name
          type: string
        last_name:
          title: Last Name
          description: Last name
          type: string
        email:
          type: string
          title: Email
          description: E-mail address
        access_profiles:
          items:
            $ref: '#/components/schemas/AccessProfile'
          type: array
          title: Access Profiles
          description: A list of access profiles that the selected user has access to
        organization_id:
          title: Organization Id
          description: The organization ID of the user.
          type: string
        is_organization_admin:
          title: Is Organization Admin
          description: True if the current user is an organization admin.
          type: boolean
        is_deployment_admin:
          title: Is Deployment Admin
          description: True if the current user is a deployment admin.
          type: boolean
        preferences:
          title: Preferences
          description: User preferences that can be stored in the Scale GenAI Platform.
          additionalProperties: true
          type: object
      type: object
      required:
      - id
      - email
      - access_profiles
      title: UserInfoBase
    Identity:
      properties:
        id:
          type: string
          title: Id
        object:
          type: string
          const: identity
          title: Object
          default: identity
        type:
          $ref: '#/components/schemas/IdentityType'
      type: object
      required:
      - id
      - type
      title: Identity
    UserPreferencesUpdateResponse:
      properties:
        updated:
          type: boolean
          title: Updated
          description: Whether the user preferences was successfully updated.
        preferences:
          title: Preferences
          description: User preferences that can be stored in the Scale GenAI Platform.
          additionalProperties: true
          type: object
      type: object
      required:
      - updated
      title: UserPreferencesUpdateResponse
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
x-assembled-from: Per-operation OpenAPI fragments embedded verbatim in docs.gp.scale.com reference pages; source spec https://api.sgp.scale.com/openapi-versions/v4/openapi.json (404 when assembled)