Download OpenAPI specification:Download
This is the Authentication API definition for the Avaya Session Border Controller for Enterprise.
Each supported endpoint is defined in this file along with a description of the endpoint, any required parameters, permissions, and the expected responses with examples.
Get a new authentication token that can be used with any endpoint running on this system.
| Authorization required | string Authorization headers. Currently, only Basic authentication is supported. |
JSON payload containing options for generated token. All keys are optional.
| capabilities | Array of strings Allows a token to optionally request less capabilities than normal to reduce impact of an accidental token exposure. |
{- "capabilities": [
- "string"
]
}"string"Invalidate an authentication token.
| token required | string |
| Authorization required | string Authorization headers. Currently, only Basic authentication is supported. |
{- "error-code": "GENERIC_ERROR",
- "message": "A generic error occurred."
}Verify that a token is valid.
| token required | string The generated JWT token to verify. |
| Authorization required | string Authorization headers. Currently, only Basic authentication is supported. |
{- "error-code": "GENERIC_ERROR",
- "message": "A generic error occurred."
}