Retrieve User

GET 
/users/:id/

Request

Path Parameters

id stringrequired

Responses

200

application/json

Schema

Schema

id stringrequired

A unique Base58 value identifying this object.

email emailrequired

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

title stringrequired
Possible values: [ceo, cto, cso, seceng, dev, devop, manager, other, ``]
Job title:
• ceo - Chief Executive Officer
• cto - Chief Technology Officer
• cso - Chief Security Officer
• seceng - Security engineer
• dev - Developer
• devop - Developer Operations
• manager - Manager
• other - Other
is_billing_admin booleanrequired

If true, the user has permissions to manage billing. Read-only.

changed_by objectrequired

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email emailrequired

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

changed date-timerequired

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

active booleanrequired

Default value: true

If true, the user can authenticate to Probely to interact with apps and the API.
If false, the user's access to Probely's apps and API is blocked.
Defaults to true.

labels object[]required
Array [
id stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
color stringrequired
Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$
Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.
changed_by objectrequired
User who last made changes.
id stringrequired
A unique Base58 value identifying this object.
email emailrequired
Possible values: <= 254 characters
Email of the user.
name stringrequired
Possible values: <= 60 characters
Name of the user.
changed date-timerequired
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
]
user_roles object[]
Array [
role objectrequired
id stringrequired
Possible values: >= 12 characters and <= 12 characters
A unique Base58 value identifying this object.
name stringrequired
scope objectrequired
tier stringrequired
Possible values: [account, team, scope]
• account - account
• team - team
• scope - scope
team object
id stringrequired
Possible values: >= 12 characters and <= 12 characters
A unique Base58 value identifying this object.
name stringrequired
target object
id stringrequired
Possible values: >= 12 characters and <= 12 characters
A unique Base58 value identifying this object.
name stringrequired
]
last_login date-timenullablerequired

Date and time of the last login of the user, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

is_apiuser booleanrequired

If true, it is an app that interacts with Probely through the API.
If false, it is a human who interacts with Probely through our web interface.
Defaults to false."

mfa_enabled booleanrequired

If true, the user has MFA (Multi-Factor Authentication) enabled at login.
Defaults to true.

Example (from schema)

{
  "id": "string",
  "email": "[email protected]",
  "name": "string",
  "title": "ceo",
  "is_billing_admin": true,
  "changed_by": {
    "id": "string",
    "email": "[email protected]",
    "name": "string"
  },
  "changed": "2024-09-10T15:58:29.799Z",
  "active": true,
  "labels": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "changed_by": {
        "id": "string",
        "email": "[email protected]",
        "name": "string"
      },
      "changed": "2024-09-10T15:58:29.799Z"
    }
  ],
  "user_roles": [
    {
      "role": {
        "id": "string",
        "name": "string"
      },
      "scope": {
        "tier": "account",
        "team": {
          "id": "string",
          "name": "string"
        },
        "target": {
          "id": "string",
          "name": "string"
        }
      }
    }
  ],
  "last_login": "2024-09-10T15:58:29.800Z",
  "is_apiuser": true,
  "mfa_enabled": true
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...