Mitel CloudLink Platform Auth API

Name: Mitel CloudLink Platform Auth API
Brand: Mitel CloudLink Platform Auth API
Availability: InStock

✓ Official Vendor SpecIdentity AuthAuthenticationoauth248 EndpointsREST

For Agents

Install Jentic One Beta

Connect the Mitel CloudLink Platform Auth API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Mitel CloudLink Platform Auth API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Mitel CloudLink Platform Auth API.

Issue access and refresh tokens via OAuth password and client_credentials grants

Refresh expired access tokens without re-prompting the user

Run authorization_code flows for browser-based application logins

GET STARTED

Start building with Mitel CloudLink Platform Auth API

Explore with Jentic

View OpenAPI Document

The Mitel CloudLink Platform Auth API is the OAuth 2.0 token service that fronts Mitel's CloudLink communications platform. It issues access and refresh tokens for users, clients, and guests, supports password, client_credentials, refresh_token, authorization_code, and token-exchange grants, and provides assume-role and SAML2 flows for cross-account administration. Use it to obtain bearer tokens for downstream CloudLink microservices, manage registered application clients, and run policy tests against a user's access scope.

Use Cases

Patterns agents use Mitel CloudLink Platform Auth API for, with concrete tasks.

★ Application Login for CloudLink Apps

Browser and mobile applications redirect the user to the Mitel auth portal, which posts the user's credentials to /authorize and returns an authorization code. The app exchanges the code at /token for an access token plus a 14-day refresh token. From there, the app can call any downstream CloudLink microservice with the bearer token.

Exchange authorization code {code} for tokens by calling POST /token with grant_type authorization_code and client credentials

Server-to-Server Service Calls

Backend services authenticate to CloudLink with client credentials to obtain a service-scoped access token that is used across downstream microservices. Tokens default to one hour and are refreshed silently. The same flow supports basic-auth header encoding when the service prefers HTTP basic over body parameters.

Call POST /token with grant_type client_credentials and your client_id and client_secret to retrieve a service token

Cross-Account Admin Switch

A partner administrator who manages multiple tenants uses the assume-role endpoint to issue a fresh token in a target account and role. This avoids logging out and back in when working across tenants and lets administrators temporarily downgrade themselves to USER role for safer testing.

Call POST /assume-role/token with body { accountId: 1234, role: USER } using the admin's existing bearer token

Agent-Driven Token Management

An automation agent discovered through Jentic obtains and rotates CloudLink tokens for downstream calls. Jentic stores the long-lived client_secret in its credential vault and the agent only invokes the token issuance operation, so refresh and assume-role flows can run without leaking the underlying secret.

Use Jentic to find the Mitel token operation, execute the client_credentials grant, and cache the returned access token for downstream calls

Key Endpoints

48 endpoints — the mitel cloudlink platform auth api is the oauth 2.

METHOD

PATH

DESCRIPTION

POST

/token

Issue access and refresh tokens via OAuth grants

POST

/guest/token

Issue a guest token for anonymous flows

POST

/assume-role/token

Switch account or role with a fresh token

POST

/authorize

Initiate the authorization code grant flow

GET

/saml2/start

Initiate SAML2 single sign-on

POST

/token

Issue access and refresh tokens via OAuth grants

POST

/guest/token

Issue a guest token for anonymous flows

POST

/assume-role/token

Switch account or role with a fresh token

POST

/authorize

Initiate the authorization code grant flow

GET

/saml2/start

Initiate SAML2 single sign-on

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

CloudLink client_id, client_secret, and user passwords are held in the Jentic credential vault. Agents call the token issuance operation through Jentic and only the short-lived access token is surfaced for downstream calls.

Intent-based discovery

Agents search Jentic with intents like get cloudlink token or refresh access token and Jentic returns the matching grant-specific operation with its input schema.

Time to first call

Direct Mitel CloudLink auth integration: 2-3 days for grant handling, refresh logic, and assume-role flows. Through Jentic: under 1 hour for the first token issuance call.

FAQs

Specific to using Mitel CloudLink Platform Auth API through Jentic.

What authentication does the Mitel CloudLink Auth API use?

The API itself issues OAuth 2.0 tokens, so it accepts grant-specific credentials at POST /token: username and password for the password grant, client_id and client_secret for client_credentials, or an authorization code for the auth code grant. Through Jentic the long-lived secrets are held in the credential vault and only the issued bearer token leaves the vault for downstream calls.

Can I refresh an expired CloudLink access token?

Yes. Call POST /token with grant_type refresh_token and the refresh_token value. Access tokens default to 1 hour and refresh tokens to 14 days, so refresh proactively before expiry to avoid 401 responses on downstream microservice calls.

What are the rate limits for the Mitel CloudLink Auth API?

Mitel applies per-client and per-account rate limits to the token endpoints to prevent credential stuffing. Tight loops on /token will be throttled. Cache issued tokens for their full lifetime rather than re-issuing per request.

How do I issue a CloudLink token through Jentic?

Search Jentic for issue cloudlink token, load the schema for POST /token, and execute with grant_type client_credentials and your client_id and client_secret. The returned access token is then used as the bearer for any downstream CloudLink microservice.

Does the Mitel CloudLink Auth API support SAML federation?

Yes. The /saml2 endpoints initiate SAML2 SSO and consume IdP responses. Use them when the customer's CloudLink account is federated to an external identity provider rather than relying on local username and password.

Can I switch an admin into a different account without re-login?

Yes. Call POST /assume-role/token with a JSON body specifying accountId and the desired role. Permissions allowing, the response is a fresh token scoped to the new account, avoiding a full logout and login cycle.

Mitel CloudLink Platform Auth API

Connect the Mitel CloudLink Platform Auth API to your agent

Capabilities

Start building with Mitel CloudLink Platform Auth API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs