PRprobely
API Users

Retrieve API User

Changed on
get/api-users/{id}/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/api-users/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

A unique Base58 value identifying this object.

Response

idstring required

A unique Base58 value identifying this object.

namestring required

Name of the user.

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.

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."

keystring required
expiration_datestring date-time nullable required
days_valid_forinteger

Number of days the API key is valid for. Set on creation only.
If omitted, the key never expires, unless the account's maximum API key duration policy is enabled: then it defaults to that maximum.
A duration above the maximum is rejected.

Changes

  • 0e9b5b5da4d0Revision changes
    • info

      added the optional write-only property days_valid_for to the response with the status

    • info

      added the required property to the response with the status

  • 8b8322107b18Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional 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

    • 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

    • 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

    • info

      added the required property // to the response with the status