Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Authenticate using application credentials and a specific owner ID, token, or enrollment. (Only Applications!)

post/access/v1/enrollment/authorize

Request body

client_idstring

The ID of the application that is being enrolled.

client_secretstring

The secret key of the application that is being enrolled.

idstring

The ID of the enrollment to authorize to use as an alternative to the owner ID.

owner_idstring

The ID of the entity that owns the enrollment. It is essential this is provided from a trusted source or an auth token is provided in the headers.

Example request

{
  "client_id": "XzhLPeXCi3GBVg",
  "client_secret": "p2NWtVpuDxDYt41crWUBmQKaE4Mh92roDxp_8UKkIJY",
  "id": "01950020-daef-7d75-b1ba-33e7e392a658",
  "owner_id": "347c5b04-cde2-11ed-afa1-0242ac120002"
}

Response

OK

app_idstring

ID of the application associated with the enrollment.

created_atstring

The date and time the enrollment was created.

{"stackTrail":"components:schemas:AccessEnrollment:properties:data","oasType":"schema","type":"unknown","title":"Data","description":"Additional data associated with the enrollment.","example":{"key":"value"}}
disabledboolean

Whether the enrollment is disabled.

idstring

UUID of the enrollment.

owner_idstring

The ID of the entity that owns the enrollment.

sandboxboolean

Indicates if the enrollment's workspace is in a sandbox environment.

tokenstring

A token that may be used to authenticate the enrollment with API operations.

token_expiresinteger

The expiration unix timestamp of the token.

updated_atstring

The date and time the enrollment was last updated.

Example response

{
  "app_id": "01900e17-db4d-78a5-8505-c93ae63e8a0d",
  "created_at": "2018-01-01T00:00:00.000Z",
  "data": {
    "key": "value"
  },
  "id": "01950020-daef-7d75-b1ba-33e7e392a658",
  "owner_id": "347c5b04-cde2-11ed-afa1-0242ac120002",
  "token_expires": 1680000000,
  "updated_at": "2018-01-01T00:00:00.000Z"
}
All 70 operations