Skip to main content

Retrieve Profile

GET 
/profile/

Request​

Query Parameters

    ordering string

    Which field to use when ordering the results.

    search string

    A search term.

Responses​

Schema

  • Array [

    • 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 Snyk API & Web to interact with apps and the API.
    If false, the user's access to Snyk API & Web's apps and API is blocked.
    Defaults to true.

    labels

    object[]

    Labels of the user.

  • 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 stringrequired

    Roles of the user.

    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 Snyk API & Web through the API.
    If false, it is a human who interacts with Snyk API & Web through our web interface.
    Defaults to false."

    intercom_user_id stringrequired

    Identifier of the user in Intercom. Read-only.

    is_sso booleanrequired

    If true, Single Sign-on (SSO) is set in the account and it is how the user authenticates.
    If false, the user authenticates with username and password.
    Read-only.

    is_owner booleanrequired

    If true, the user is responsible for the account and the main point of contact. Read-only.

    mfa_enabled boolean
    first_login date-timenullable

    Date and time of user's first login

    snyk_app_public_url stringrequired

    URL of the Snyk application for the user's Snyk Customer.

    tos_accepted date-timenullablerequired

    Timestamp for the user's acceptance of the Terms of Service

  • ]

Loading...