client_idstringrequired
Example:00000000-0000-0000-0000-000000000000
scopestringrequired
Example:offline asset:read
redirect_uristringrequired
Example:https://localhost/callback
response_typestringrequired
Example:code
statestring
Example:xyz
Authorize endpoint
When using the Authorization Code grant, redirect the user to the Authorize application endpoint. After the user is authenticated and approves the authorization request, Bynder will redirect the user back with an authorization code which can then be passed to the Token endpoint.
get
/v6/authentication/oauth2/auth
Query Parameters
Response
302 text/plain
Response
302 text/plain
Found. Redirecting to the login provider.
302 text/plain
Token endpoint
Use the token endpoint to retrieve a access token which can be used to authorize API
requests. Depending on the type of grant, different fields are required which are
outlined per request.
The token endpoint requires authorization either in the body or by
sending the Authorization header.
Using an authorization code
Use the token endpoint to retrieve an access token which can be used to authorize API
requests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials grant.
post
/v6/authentication/oauth2/token{authorization}
Body
application/x-www-form-urlencoded
Body
application/x-www-form-urlencoded
client_idstring
Application client ID.
Example:00000000-0000-0000-0000-000000000000
client_secretstring
Application client secret.
Example:00000000-0000-0000-0000-000000000000
codestring
The Authorization Code returned from the Authorize application request.
Example:6440327e7ddb660435e377a17a5463ba
grant_typestring
Identifies the grant type being used. For Authorization Code grant use authorization_code.
Example:authorization_code, refresh_token, client_credentials
redirect_uristring
The URL specified in the Authorize application request, the values must match.
Example:https://localhost/callback
scopestring
List of scopes to request to be granted to the access token. Can only be a subset of the scopes requested in the Authorize application request. When not passed, all the scopes will be requested.
Example:offline asset:read
Response
200 application/json
Response
200 application/json
Successful response
access_tokenstring
Example:eyJh...NDcw
expires_ininteger
Example:3600
refresh_tokenstring
Example:c12e...b5dc
scopestring
Example:offline asset:read
token_typestring
Example:bearer
200 application/json
Using client credentials
Use the token endpoint to retrieve an access token which can be used to authorize API
requests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials grant.
post
/v6/authentication/oauth2/token{client_credentials}
Body
application/x-www-form-urlencoded
Body
application/x-www-form-urlencoded
client_idstring
Application client ID.
Example:00000000-0000-0000-0000-000000000000
client_secretstring
Application client secret.
Example:00000000-0000-0000-0000-000000000000
grant_typestring
Identifies the grant type being used. For Authorization Code grant use authorization_code.
Example:authorization_code, refresh_token, client_credentials
scopestring
List of scopes to request to be granted to the access token. Can only be a subset of the scopes requested in the Authorize application request. When not passed, all the scopes will be requested.
Example:offline asset:read
Response
200 application/json
Response
200 application/json
Successful response
access_tokenstring
Example:eyJh...NDcw
expires_ininteger
Example:3600
refresh_tokenstring
Example:c12e...b5dc
scopestring
Example:offline asset:read
token_typestring
Example:bearer
200 application/json
Using a refresh token
Use the token endpoint to retrieve an access token which can be used to authorize API
requests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials grant.
post
/v6/authentication/oauth2/token{refresh}
Body
application/x-www-form-urlencoded
Body
application/x-www-form-urlencoded
client_idstring
Application client ID.
Example:00000000-0000-0000-0000-000000000000
client_secretstring
Application client secret.
Example:00000000-0000-0000-0000-000000000000
grant_typestring
Identifies the grant type being used. For Authorization Code grant use authorization_code.
Example:authorization_code, refresh_token, client_credentials
refresh_tokenstring
Refresh token returned from the Retrieve token request.
Example:c11e...b5bc
Response
200 application/json
Response
200 application/json
Successful response
access_tokenstring
Example:eyJh...NDcw
expires_ininteger
Example:3600
refresh_tokenstring
Example:c12e...b5dc
scopestring
Example:offline asset:read
token_typestring
Example:bearer
200 application/json