Skip to main content
GET
/
api
/
svc
/
v1
/
users
/
{id}
Get a user
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/users/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "jqfwg345gi25n5ju2yz5iz6m",
    "email": "<string>",
    "tenantName": "<string>",
    "metadata": {
      "sub": "<string>",
      "imageURL": "<string>",
      "pictureDownloadPath": "<string>",
      "displayName": "<string>",
      "userObject": {},
      "inviteAccepted": true,
      "registeredInIdp": true,
      "preference": {},
      "groups": [
        "<string>"
      ],
      "ssoName": "<string>",
      "scimUserObject": {},
      "createdByScim": true
    },
    "active": true,
    "isEditable": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "roles": [
      "<string>"
    ],
    "rolesWithResource": [
      {
        "roleId": "<string>",
        "resourceId": "<string>",
        "roleName": "<string>"
      }
    ],
    "accounts": [
      {
        "accountId": "<string>",
        "name": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

System-generated user ID.

Example:

"jqfwg345gi25n5ju2yz5iz6m"

Response

The user with the given ID.

​
data
User · object
required

The requested user.