Provides un-authenticated utility methods.
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.
{ "username" : "pmorley", "password" : "cGFzc3dvcmQ=", "provider" : "LOCAL" }
besng-basic cHJvdmlkZXI9IkxPQ0FMIiB0ZW5hbnQ9InNhbXBsZVRlbmFudCIgdXNlcm5hbWU9InBtb3JsZXkiIGNyZWRlbnRpYWxzPSJwYXNzd29yZCI=
{ "username" : "pmorley", "password" : "cGFzc3dvcmQ=", "domain" : "example.com", "provider" : "AD" }
besng-basic cHJvdmlkZXI9IkFEIiB0ZW5hbnQ9InNhbXBsZVRlbmFudCIgZG9tYWluPSJleGFtcGxlLmNvbSIgdXNlcm5hbWU9InBtb3JsZXkiIGNyZWRlbnRpYWxzPSJwYXNzd29yZCI=
Name | Location | Description |
---|---|---|
tenantGuid | path | The tenantGuid to generate the authorization header for. |
Media type | Data type |
---|---|
application/vnd.blackberry.authorizationrequest-v1+json | Authorization request (JSON) |
Code | Condition |
---|---|
200 | OK. |
400 | Invalid request. For example, invalid field semantics or missing required field. |
Media type | Data type |
---|---|
text/plain | (custom) |
Returns the current uptime of the server. This is an un-authenticated call and can be used to test if the server is up and running before attempting to access authenticated routes.
Code | Condition |
---|---|
200 | The server is up and available |
404 | The server is not available |
Media type | Data type |
---|---|
text/plain | (custom) |