Skip to main content

Retrieve User

GET 
/users/:id/

Request​

Path Parameters

    id stringrequired

Responses​

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 string

    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

    object

    required

    User who last made changes.

    id stringrequired

    A unique Base58 value identifying this object.

    email email

    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 boolean

    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 string

    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

    object

    required

    User who last made changes.

    id stringrequired

    A unique Base58 value identifying this object.

    email email

    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

    object

    required

    id stringrequired

    Possible values: >= 12 characters and <= 12 characters

    A unique Base58 value identifying this object.

    name stringrequired

    scope

    object

    required

    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.

Loading...