Utilities Resource

Provides unauthenticated utility methods.

POST /{tenantGuid}/api/v1/util/authorization

Available Since:
12.6.0

Generate an authorization header value for authenticating API calls. Use the string returned in the body as the 'Authorization' header value for subsequent authenticated API calls. The password must be base64-encoded. A 400 error will be returned if the provided credentials are invalid.

NOTE: The password in the request must be base64-encoded.

Sample request for a local user

  {
    "username" : "pmorley",
    "password" : "cGFzc3dvcmQ=",
    "provider" : "LOCAL"
  }

Sample response body

NOTE: Treat the response information as sensitive. Do not cache or store in an insecure way. 
  besng-basic cHJvdmlkZXI9IkxPQ0FMIiB0ZW5hbnQ9InNhbXBsZVRlbmFudCIgdXNlcm5hbWU9InBtb3JsZXkiIGNyZWRlbnRpYWxzPSJwYXNzd29yZCI=

Sample request for an AD user

  {
    "username" : "pmorley",
    "password" : "cGFzc3dvcmQ=",
    "domain" : "example.com",
    "provider" : "AD"
  }

Sample response body

NOTE: Treat the response information as sensitive. Do not cache or store in an insecure way. 
  besng-basic cHJvdmlkZXI9IkFEIiB0ZW5hbnQ9InNhbXBsZVRlbmFudCIgZG9tYWluPSJleGFtcGxlLmNvbSIgdXNlcm5hbWU9InBtb3JsZXkiIGNyZWRlbnRpYWxzPSJwYXNzd29yZCI=

Request Parameters
Name Location Description
tenantGuid path The tenantGuid to generate the authorization header for.
Request Body
Media type Data type
application/vnd.blackberry.authorizationrequest-v1+json Authorization request (JSON)
Response Codes
Code Condition
200 OK.
400 Invalid request. For example, invalid field semantics or missing required field.
Response Body
Media type Data type Description
text/plain object

GET /{tenantGuid}/api/v1/util/ping

Available Since:
12.6.0

Ping server and get the current uptime of the server. This is an unauthenticated call and can be used to test if the server is up and running before attempting to access authenticated routes.

Response Codes
Code Condition
200 The server is up and available
404 The server is not available
Response Body
Media type Data type Description
text/plain string