Get authorization-server metadata

GET https://api.voicecheap.ai/.well-known/oauth-authorization-server

​

Authentication

​

Request examples

curl --request GET 'https://api.voicecheap.ai/.well-known/oauth-authorization-server'

const input = {};
const response = await fetch('https://api.voicecheap.ai/.well-known/oauth-authorization-server', {
  method: 'GET',
  headers: {},
  redirect: 'manual',
});
console.log(response.status, await response.text());

import os
import requests

response = requests.request(
    "GET",
    "https://api.voicecheap.ai/.well-known/oauth-authorization-server",
    headers={},
    timeout=120,
    allow_redirects=False,
)
print(response.status_code, response.text)

​

Response

{
  "issuer": "https://api.voicecheap.ai",
  "authorization_endpoint": "https://api.voicecheap.ai/oauth/authorize",
  "token_endpoint": "https://api.voicecheap.ai/oauth/token",
  "registration_endpoint": "https://api.voicecheap.ai/oauth/register",
  "revocation_endpoint": "https://api.voicecheap.ai/oauth/revoke",
  "response_types_supported": ["code"],
  "response_modes_supported": ["query"],
  "grant_types_supported": ["authorization_code", "refresh_token"],
  "token_endpoint_auth_methods_supported": ["none"],
  "revocation_endpoint_auth_methods_supported": ["none"],
  "code_challenge_methods_supported": ["S256"],
  "scopes_supported": [
    "account:read",
    "usage:read",
    "settings:read",
    "settings:write",
    "team:read",
    "team:write",
    "projects:read",
    "projects:write",
    "projects:delete",
    "translations:write",
    "transcription:read",
    "transcription:write",
    "subtitles:read",
    "subtitles:write",
    "tts:read",
    "tts:write",
    "voices:read",
    "voices:write",
    "images:read",
    "images:write",
    "thumbnails:read",
    "thumbnails:write",
    "folders:read",
    "folders:write",
    "glossary:read",
    "glossary:write",
    "webhooks:read",
    "webhooks:write",
    "publishing:read",
    "publishing:write",
    "offline_access"
  ],
  "authorization_response_iss_parameter_supported": true,
  "client_id_metadata_document_supported": true
}

​

Operation notes

• Only the code response type and query response mode are advertised.
• Clients can use dynamic registration or a Client ID Metadata Document (CIMD). client_id_metadata_document_supported is true; a CIMD client uses its public HTTPS document URL as client_id.
• A CIMD JSON document must contain an exact matching client_id, a nonempty client_name of at most 120 characters, and 1–10 exact redirect_uris. Use public-client authentication none with S256 PKCE; authorization_code is required and refresh_token is optional.
• Serve CIMD as uncompressed JSON over public HTTPS on port 443, with an explicit path, without credentials, fragments, dot segments, or redirects. The document must be at most 64 KiB and respond within 5 seconds. Cached metadata expires within 5 minutes; token exchange and refresh use the metadata bound to the grant.
• When OpenID Connect is available, authorization-server metadata also advertises openid and email scopes, userinfo_endpoint, and jwks_uri. Otherwise these scopes and endpoints are absent from that metadata.
• Token and revocation authentication methods are none. Public clients use client_id and S256 PKCE instead of a client secret.
• offline_access is a renewal-related scope marker, not a product permission. Issuing a refresh token depends on whether refresh_token was registered as a grant type.
• Check the returned iss value on the final client callback against issuer. Both successful and denied authorization callbacks include iss, and echo state when one was supplied.

​

Errors