User info

Get basic information for the logged in user making this request including preferences.

GET /user-info

Python

Python

import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
user_info = client.users.info()
print(user_info.id)

200

{
  "id": "<string>",
  "email": "<string>",
  "access_profiles": [
    {
      "id": "<string>",
      "identity": {
        "id": "<string>",
        "type": "user",
        "object": "identity"
      },
      "role": "manager",
      "account": {
        "id": "<string>",
        "name": "<string>",
        "status": "<string>",
        "organization_id": "<string>"
      }
    }
  ],
  "first_name": "<string>",
  "last_name": "<string>",
  "organization_id": "<string>",
  "is_organization_admin": true,
  "is_deployment_admin": true,
  "preferences": {},
  "assumed_access_profile": {
    "id": "<string>",
    "identity": {
      "id": "<string>",
      "type": "user",
      "object": "identity"
    },
    "role": "manager",
    "account": {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "organization_id": "<string>"
    }
  }
}

Response

200 - application/json

Successful Response

id · string · required

User id

email · string · required

E-mail address

access_profiles · AccessProfile · object[] · required

A list of access profiles that the selected user has access to

Show child attributes

first_name · string

First name

last_name · string

Last name

organization_id · string

The organization ID of the user.

is_organization_admin · boolean

True if the current user is an organization admin.

is_deployment_admin · boolean

True if the current user is a deployment admin.

preferences · Preferences · object

User preferences that can be stored in the Scale GenAI Platform.

assumed_access_profile · AccessProfile · object

Present if the user has assumed a specific access profile via JWT token.

Show child attributes