API docs by Redocly

Authentication API for Avaya Session Border Controller for Enterprise (Release 10.2.1.0 / Spec Revision 1.0)

Download OpenAPI specification:Download

License: Proprietary - see the bundled API Quick Start Guide or visit Avaya DevConnect.

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 Public Key

Returns the public key associated with the private key used to sign JWT tokens issued by this endpoint.

Responses

Response samples

Content type
No sample

Get Authentication Token

Get a new authentication token that can be used with any endpoint running on this system.

header Parameters
Authorization
required
string

Authorization headers. Currently, only Basic authentication is supported.

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "capabilities": [
    ]
}

Response samples

Content type
application/json
"string"

Invalidate Authentication Token

Invalidate an authentication token.

query Parameters
token
required
string
header Parameters
Authorization
required
string

Authorization headers. Currently, only Basic authentication is supported.

Responses

Response samples

Content type
application/json
{
  • "error-code": "GENERIC_ERROR",
  • "message": "A generic error occurred."
}

Verify Authentication Token

Verify that a token is valid.

query Parameters
token
required
string

The generated JWT token to verify.

header Parameters
Authorization
required
string

Authorization headers. Currently, only Basic authentication is supported.

Responses

Response samples

Content type
application/json
{
  • "error-code": "GENERIC_ERROR",
  • "message": "A generic error occurred."
}