auth

Download Spec

post /auth/api/v1/oauth/clientcredentials/{domain}/token

Access Token Request https://tools.ietf.org/html/rfc6749. Supported grant types by OAuth domain:

  • privx-external: client_credentials (requires privx-external.client_type="public")

grant_type

string

required

OAuth 2.0 grant type, RFC6749

Enum
  • client_credentials

client_id

string

API client or trusted client ID

Example
"api-client-id"

client_secret

string

API client or trusted client secret

Example
"api-client-secret"

Request

{
  "grant_type": "client_credentials",
  "client_id": "api-client-id",
  "client_secret": "api-client-secret"
}

Response

ExamplesSchema

Successful response, returns JSON object

{
  "access_token": "eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0=.eyJhdWQiOiJwcml2eC11aSIsImV4cCI6MTUyMjgzNjAxNSwiaWF0IjoxNTIyODM1NzE1LCJpc3MiOiJvYW0uYXV0aC5zc2guY29tIiwiZG9tYWluIjoicHJpdngtdWkiLCJwZXJtaXNzaW9ucyI6InByaXZ4LWFkbWluLHByaXZ4LXVzZXIiLCJzZXNzaW9uaWQiOiI4MWI2NjNiOC02Zjc5LTQ3ZjctNzY0Yy03MTdmMGEwNjk0MjYiLCJ1c2VyaWQiOiJhOGMyNjM5NS0zMmZjLTQxMjctYmRiNy04MDllZThhMjAzZjIifQ==.JM6RrCYg9djDnoJtRkAMAKvkM2Zm9dYuxgN1zZA7G1-XTCc4Iub_y6lKdhHnoRm_hUwW6QtRWm8IlAUayqs4Aw",
  "token_type": "bearer",
  "expires_in": 300,
  "refresh_token": "I7SNNZH4GLZNCOIV7D6DKULPFXBWBD4TTZJ5KQDCO3N2W7D562WSE5QWSNQFO7OTG5VRGPDU73SEUR5NVTXLPNDV6TQD6OH6V7S3JNWNFSPZ3ARSSJKJO6MSPVHRY3OFFXN4YLRDZPODQCDW6UL27PLR2YWUOUHF5WBIKZVDR4H5R4VQSPPKBBJC4GWJ3XAPWZL4DBVT6YH6PVBWMOKJHDO66577OBJVOOKWAVY7JEFQTTZNRTNDXPHI42AGHMCNWHFBSG63PXSMO67YQJBC55CHAQQI3XS3ZUCQ",
  "scope": "privx-user connections-manual"
}

post /auth/api/v1/logout

User logout.

Response

ExamplesSchema

Successful response

Empty response

Was this page helpful?