oauth

Download Spec

get /auth/api/v1/oauth/authorize

Redirects the request to login. OAuth2.0 Authorize Request

response_type

string

client_id

string

state

string

redirect_uri

string

user_agent

string

oidc_id

string

scope

string

Response

ExamplesSchema

Temporary redirect

Empty response

post /auth/api/v1/oauth/token

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

  • privx-ui: authorization_code
  • privx-external: authorization_code, password
  • privx-service: client_credentials

client_id

string

OAuth2.0 client ID

Example
"privx-ui"

grant_type

string

Grant type

Enum
  • authorization_code
  • refresh_token
  • password
  • client_credentials

refresh_token

string

Optional. Used if grant_type is refresh_token

Example
"J3O4AOSWDNLPLMMWL2ESFJ4GQHSNBXS7SBXOAGYD7BPMCHTJ4ZE7TJQNMDKPGDPHNNI5KY4P3HPF3GNV2RZOIW7RFQZIOZ5CNAKVIZGDFY4VAGHL3HHP447AW2BVZG5NN2GCV6XGDM5P434AOMMMNNTQHGHUNQFYNBOBB5BW7QISG77GVAIPQQA7UP5I7ES3KXLXNRZUDDEMFO6MVRXV7OOK5YSV4QFDRTSOOGGHE63R5G5T3EUM5LPPVCCSWUZ42YZCQOTVLPFED4WPEENQPMGMTPZ4VSRU2RIQ"

code

string

Optional. Used if grant_type is authorization_code

Example
"ZWRHCAS2QGV6CVB6C4JHDSKEGEJLE6CGNJVHMQWC7PQZOOCE7IXEYLHZPTMMQ6OHSDBLH6SFRQPEQL5CKP2MZNF42QYJL6DBKMPRLEA3JW4ZD5DIKZJF7YYRIYDAXH4NXZSVSXFHHAMHI6Z6OHXY32S2MWZUASWJHSTOHJBWTS7SGUDGTDMSWNHTHKFR4GKVUUJIX3L6KRBUYGUE77MZGN7PTAJNP7WNDUIOJPKK7M5WATRL6QIGMHREIE5DXGDI6UOCRLBQBSJAW7MTOCAR2VS4CXRAS5FOUMH6R76B4LXISQYW4SE55BVI5DAZLTTHUFKEYAZOLQX6Y6Q52YXTTNYKTZRCKTDEMVYZDDTEBYVBBW4V2EKPJ2QDYPXGQ2KWLUBVAHXNI2BWM7AODHB5AFY"

redirect_uri

string

Optional. Used if grant_type is authorization_code

Example
"/privx/oauth-callback"

username

string

Optional. Used if grant_type is password

password

string

Optional. Used if grant_type is password

scope

string

Optional. Used if grant_type is password.

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

Was this page helpful?