Avaya Experience Platform

Avaya Experience Platform is a contact center and unified communications platform that provides voice, chat, email, and messaging services along with agent and device management.

Use Cases the Adapter Solves

• Review contact-center identities: Identify Avaya Experience Platform users and their roles to support access reviews.
• Track voice-service devices: Maintain visibility of Avaya Aura Device Services devices, including their hostnames and status.

Asset Types Fetched

• Devices
• Users

Data Retrieved through the Adapter

Devices - fields such as: Device Name, Hostname, Port, AADS Status

Users - fields such as: Username, Email, Display Name, Admin Roles

Before You Begin

Required Ports

• TCP port 443 (HTTPS)

Authentication Methods

The adapter uses OAuth 2.0 client credentials authentication.

APIs

Axonius uses the Avaya Experience Platform API. The following endpoints are called:

• POST /api/auth/v1/{accountId}/protocol/openid-connect/token - Obtain an access token using client credentials.
• GET /api/admin/user/v1/accounts/{accountId}/users - Retrieve users.
• GET /api/admin/voice/v1/accounts/{accountId}/avaya-aura-device-services - Retrieve Avaya Aura Device Services devices.

Required Permissions

Avaya provisions the client credentials with the roles and permissions that match the APIs listed in the Scope field of the OneCare Client Access Request. In the request, list the User Management API and the Voice Admin API so that the client can access the endpoints listed above.

The User APIs require the Account Administrator role. Confirm the role required to access Avaya Aura Device Services through the Voice Admin API with your Avaya administrator.

Supported From Version

Supported from Axonius version 10.0.1

Setting Up Avaya Experience Platform to Work with Axonius

1. Obtain the Client ID, Client Secret, and Application Key through the OneCare Client Access Request for AXP APIs.
2. Record the six-character Account ID.
3. Identify the regional Avaya Experience Platform API host, including the https:// prefix.

Connecting the Adapter in Axonius

1. Navigate to the Adapter Catalog, search for Avaya Experience Platform, and select the adapter.
2. Click Add Connection.
3. Provide the following parameters.

Required Parameters

1. Host Name or IP Address - Enter the regional Avaya Experience Platform API host, including the https:// prefix. Do not add a specific API endpoint. Example: https://us.api.avayacloud.com
2. Account ID - Enter the six-character Avaya Experience Platform account ID.
3. Client ID - Enter the client ID for the OAuth 2.0 client credentials flow.
4. Client Secret - Enter the client secret for the OAuth 2.0 client credentials flow.
5. Application Key - Enter the application key issued with the client credentials.

Optional Parameters

1. Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.
2. HTTPS Proxy - Connect the adapter to a proxy instead of directly connecting it to the host.
3. HTTPS Proxy User Name - Enter the user name to use when connecting through HTTPS Proxy.
4. HTTPS Proxy Password - Enter the password to use when connecting through HTTPS Proxy.

To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.