User

Retrieve Profile

Changed on
get/profile/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/profile/
  • Auth
    API key in header Authorization

Query parameters

orderingstring

Which field to use when ordering the results.

searchstring

A search term.

Response

idstring required

A unique Base58 value identifying this object.

emailstring email required

Email of the user.

namestring required

Name of the user.

title'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_adminboolean required

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

changedstring date-time required

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

activeboolean

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.

user_rolesstring required

Roles of the user.

last_loginstring date-time nullable required

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

is_apiuserboolean required

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_idstring required

Identifier of the user in Intercom. Read-only.

is_ssoboolean required

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_ownerboolean required

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

mfa_enabledboolean
first_loginstring date-time nullable

Date and time of user's first login

snyk_app_public_urlstring required

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

tos_acceptedstring date-time nullable required

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

snyk_permissions_syncstring required

Status of the Snyk permission sync for the current session: pending, synced, or failed. null when the account is not managed by Snyk. Read-only.

snyk_tenant_syncstring required

Status of the account's initial Snyk org sync: synced, syncing, waiting_for_tenant_admin (a Tenant Admin has to log in with Snyk first), or failed. Groups and orgs can be browsed once it is synced. null when the account is not managed by Snyk. Read-only.

Changes

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status