Skip to main content
Version: v41

tokenRequest

OAuth2.0 Access token request.

client_idstring

OAuth2.0 client ID

Example: privx-ui
grant_typestring

Grant type

Possible values: [authorization_code, refresh_token, password, client_credentials]

refresh_tokenstring

Optional. Used if grant_type is refresh_token

Example: J3O4AOSWDNLPLMMWL2ESFJ4GQHSNBXS7SBXOAGYD7BPMCHTJ4ZE7TJQNMDKPGDPHNNI5KY4P3HPF3GNV2RZOIW7RFQZIOZ5CNAKVIZGDFY4VAGHL3HHP447AW2BVZG5NN2GCV6XGDM5P434AOMMMNNTQHGHUNQFYNBOBB5BW7QISG77GVAIPQQA7UP5I7ES3KXLXNRZUDDEMFO6MVRXV7OOK5YSV4QFDRTSOOGGHE63R5G5T3EUM5LPPVCCSWUZ42YZCQOTVLPFED4WPEENQPMGMTPZ4VSRU2RIQ
codestring

Optional. Used if grant_type is authorization_code

Example: ZWRHCAS2QGV6CVB6C4JHDSKEGEJLE6CGNJVHMQWC7PQZOOCE7IXEYLHZPTMMQ6OHSDBLH6SFRQPEQL5CKP2MZNF42QYJL6DBKMPRLEA3JW4ZD5DIKZJF7YYRIYDAXH4NXZSVSXFHHAMHI6Z6OHXY32S2MWZUASWJHSTOHJBWTS7SGUDGTDMSWNHTHKFR4GKVUUJIX3L6KRBUYGUE77MZGN7PTAJNP7WNDUIOJPKK7M5WATRL6QIGMHREIE5DXGDI6UOCRLBQBSJAW7MTOCAR2VS4CXRAS5FOUMH6R76B4LXISQYW4SE55BVI5DAZLTTHUFKEYAZOLQX6Y6Q52YXTTNYKTZRCKTDEMVYZDDTEBYVBBW4V2EKPJ2QDYPXGQ2KWLUBVAHXNI2BWM7AODHB5AFY
redirect_uristring

Optional. Used if grant_type is authorization_code

Example: /privx/oauth-callback
usernamestring

Optional. Used if grant_type is password

passwordstring

Optional. Used if grant_type is password

scopestring

Optional. Used if grant_type is password.

tokenRequest
{
"client_id": "privx-ui",
"grant_type": "authorization_code",
"refresh_token": "J3O4AOSWDNLPLMMWL2ESFJ4GQHSNBXS7SBXOAGYD7BPMCHTJ4ZE7TJQNMDKPGDPHNNI5KY4P3HPF3GNV2RZOIW7RFQZIOZ5CNAKVIZGDFY4VAGHL3HHP447AW2BVZG5NN2GCV6XGDM5P434AOMMMNNTQHGHUNQFYNBOBB5BW7QISG77GVAIPQQA7UP5I7ES3KXLXNRZUDDEMFO6MVRXV7OOK5YSV4QFDRTSOOGGHE63R5G5T3EUM5LPPVCCSWUZ42YZCQOTVLPFED4WPEENQPMGMTPZ4VSRU2RIQ",
"code": "ZWRHCAS2QGV6CVB6C4JHDSKEGEJLE6CGNJVHMQWC7PQZOOCE7IXEYLHZPTMMQ6OHSDBLH6SFRQPEQL5CKP2MZNF42QYJL6DBKMPRLEA3JW4ZD5DIKZJF7YYRIYDAXH4NXZSVSXFHHAMHI6Z6OHXY32S2MWZUASWJHSTOHJBWTS7SGUDGTDMSWNHTHKFR4GKVUUJIX3L6KRBUYGUE77MZGN7PTAJNP7WNDUIOJPKK7M5WATRL6QIGMHREIE5DXGDI6UOCRLBQBSJAW7MTOCAR2VS4CXRAS5FOUMH6R76B4LXISQYW4SE55BVI5DAZLTTHUFKEYAZOLQX6Y6Q52YXTTNYKTZRCKTDEMVYZDDTEBYVBBW4V2EKPJ2QDYPXGQ2KWLUBVAHXNI2BWM7AODHB5AFY",
"redirect_uri": "/privx/oauth-callback",
"username": "string",
"password": "string",
"scope": "string"
}