Performs a login for the specified user and returns an authentication token.
Before proceeding to retrieve the API access token, you must generate your API key set from your profile page in the BlueCat Edge UI. For more information, refer to Profile.
Attention: Any API access key set created before activating or deactivating the
SSO integration won't be valid in the new SSO state. You must create a new API access
key set in the new SSO state to continue to use the BlueCat Edge API. If you deactivate or
activate the SSO integration again, you can use the API access key set that was
previously created.
Request: POST https://api-<BlueCat.edge.url>/v1/api/authentication/token
{
"grantType": "ClientCredentials",
"clientCredentials": {
"clientId": "<clientId>",
"clientSecret": "<clientSecret>"
}
}
Response
200 OK
Content-Type: application/JSON
{
"accessToken": "access token",
"expiresIn": "expiry time",
"tokenType": "token type"
}
Attention: The
accessToken
returned is used as the authorization
bearer token within the header when invoking other BlueCat Edge API methods.Successful response
- OK - Successful request
Possible error codes
- BAD REQUEST - Request is invalid
- INTERNAL SERVER ERROR - Unexpected error