v1

latestOpenAPI 3.0.1License2026-07-17236107.1 KB

developers

Get OP Discovery Configuration

post/get-discovery

Request body

op_configuration_endpointstring required

The openid configuration endpoint URL. If missing, then op_host must be defined.

op_hoststring

Deprecated in favor of op_configuration_endpoint. It will be removed in future version(s). Provide the URL of OpenID Provider (OP) in this field. If missing, then op_configuration_endpoint must be defined.

op_discovery_pathstring

Deprecated in favor of op_configuration_endpoint. It will be removed in future version(s). Provide path to the OpenID Connect Provider's discovery document in this field. For example, if it is 'https://example.com/.well-known/openid-configuration' then the path is blank. But if it is 'https://example.com/oxauth/.well-known/openid-configuration' then the path is '/oxauth'

Example request

{
  "op_configuration_endpoint": "https://op.example.com/acme/.well-known/openid-configuration",
  "op_host": "https://<ophostname>",
  "op_discovery_path": "/oxauth"
}

Response

issuerstring

authorization_endpointstring

token_endpointstring

token_revocation_endpointstring

user_info_endpointstring

client_info_endpointstring

check_session_iframestring

end_session_endpointstring

jwks_uristring

registration_endpointstring

id_generation_endpointstring

introspection_endpointstring

scopes_supportedstring[]

response_types_supportedstring[]

grant_types_supportedstring[]

acr_values_supportedstring[]

subject_types_supportedstring[]

user_info_signing_alg_values_supportedstring[]

user_info_encryption_alg_values_supportedstring[]

user_info_encryption_enc_values_supportedstring[]

id_token_signing_alg_values_supportedstring[]

id_token_encryption_alg_values_supportedstring[]

id_token_encryption_enc_values_supportedstring[]

request_object_signing_alg_values_supportedstring[]

request_object_encryption_alg_values_supportedstring[]

request_object_encryption_enc_values_supportedstring[]

token_endpoint_auth_methods_supportedstring[]

token_endpoint_auth_signing_alg_values_supportedstring[]

display_values_supportedstring[]

claim_types_supportedstring[]

claims_supportedstring[]

id_token_token_binding_cnf_values_supportedstring[]

service_documentationstring

claims_locales_supportedstring[]

ui_locales_supportedstring[]

claims_parameter_supportedboolean

request_parameter_supportedboolean

request_uri_parameter_supportedboolean

require_request_uri_registrationboolean

tls_client_certificate_bound_access_tokensboolean

front_channel_logout_supportedboolean

front_channel_logout_session_supportedboolean

op_policy_uristring

op_tos_uristring

scope_to_claims_mappingobject

Example response

{
  "issuer": "https://<ophostname>",
  "authorization_endpoint": "https://<ophostname>/oxauth/restv1/authorize",
  "token_endpoint": "https://<ophostname>/oxauth/restv1/token",
  "token_revocation_endpoint": "https://<ophostname>/oxauth/restv1/token/v1",
  "user_info_endpoint": "https://<ophostname>/oxauth/restv1/userinfo",
  "client_info_endpoint": "https://<ophostname>/oxauth/restv1/clientinfo",
  "check_session_iframe": "https://<ophostname>/oxauth/opiframe.htm",
  "end_session_endpoint": "https://<ophostname>/oxauth/restv1/end_session",
  "jwks_uri": "https://<ophostname>/oxauth/restv1/jwks",
  "registration_endpoint": "https://<ophostname>/oxauth/restv1/register",
  "id_generation_endpoint": "https://<ophostname>/oxauth/restv1/id",
  "introspection_endpoint": "https://<ophostname>/oxauth/restv1/introspection",
  "scopes_supported": [
    "owner",
    "casa",
    "address",
    "clientinfo",
    "user_name",
    "openid",
    "profile",
    "uma_protection",
    "admin",
    "permission",
    "manage",
    "phone",
    "mobile_phone",
    "name",
    "oxd",
    "email"
  ],
  "response_types_supported": [
    "token id_token",
    "token code id_token",
    "token",
    "token code",
    "code",
    "code id_token",
    "id_token"
  ],
  "grant_types_supported": [
    "authorization_code",
    "refresh_token",
    "urn:ietf:params:oauth:grant-type:uma-ticket",
    "password",
    "implicit",
    "client_credentials"
  ],
  "acr_values_supported": [
    "u2f",
    "super_gluu",
    "otp",
    "auth_ldap_server"
  ],
  "subject_types_supported": [
    "public",
    "pairwise"
  ],
  "user_info_signing_alg_values_supported": [
    "HS256",
    "HS384",
    "HS512",
    "RS256",
    "RS384",
    "RS512",
    "ES256",
    "ES384",
    "ES512"
  ],
  "user_info_encryption_alg_values_supported": [
    "RSA1_5",
    "RSA-OAEP",
    "A128KW",
    "A256KW"
  ],
  "user_info_encryption_enc_values_supported": [
    "RSA1_5",
    "RSA-OAEP",
    "A128KW",
    "A256KW"
  ],
  "id_token_signing_alg_values_supported": [
    "none",
    "HS256",
    "HS384",
    "HS512",
    "RS256",
    "RS384",
    "RS512",
    "ES256",
    "ES384",
    "ES512"
  ],
  "id_token_encryption_alg_values_supported": [
    "RSA1_5",
    "RSA-OAEP",
    "A128KW",
    "A256KW"
  ],
  "id_token_encryption_enc_values_supported": [
    "A128CBC+HS256",
    "A256CBC+HS512",
    "A128GCM",
    "A256GCM"
  ],
  "request_object_signing_alg_values_supported": [
    "none",
    "HS256",
    "HS384",
    "HS512",
    "RS256",
    "RS384",
    "RS512",
    "ES256",
    "ES384",
    "ES512"
  ],
  "request_object_encryption_alg_values_supported": [
    "RSA1_5",
    "RSA-OAEP",
    "A128KW",
    "A256KW"
  ],
  "request_object_encryption_enc_values_supported": [
    "A128CBC+HS256",
    "A256CBC+HS512",
    "A128GCM",
    "A256GCM"
  ],
  "token_endpoint_auth_methods_supported": [
    "client_secret_basic",
    "client_secret_post",
    "client_secret_jwt",
    "private_key_jwt"
  ],
  "token_endpoint_auth_signing_alg_values_supported": [
    "HS256",
    "HS384",
    "HS512",
    "RS256",
    "RS384",
    "RS512",
    "ES256",
    "ES384",
    "ES512"
  ],
  "display_values_supported": [
    "page",
    "popup"
  ],
  "claim_types_supported": [
    "normal"
  ],
  "claims_supported": [
    "street_address",
    "country",
    "zoneinfo",
    "birthdate",
    "role",
    "gender",
    "formatted",
    "user_name",
    "phone_mobile_number",
    "preferred_username",
    "locale",
    "inum",
    "updated_at",
    "nickname",
    "email",
    "website",
    "email_verified",
    "profile",
    "locality",
    "phone_number_verified",
    "given_name",
    "middle_name",
    "picture",
    "name",
    "phone_number",
    "postal_code",
    "region",
    "family_name"
  ],
  "id_token_token_binding_cnf_values_supported": [
    "tbh"
  ],
  "service_documentation": "http://<op_docs>",
  "claims_locales_supported": [
    "en"
  ],
  "ui_locales_supported": [
    "en",
    "es"
  ],
  "claims_parameter_supported": true,
  "request_parameter_supported": true,
  "request_uri_parameter_supported": true,
  "require_request_uri_registration": true,
  "tls_client_certificate_bound_access_tokens": true,
  "front_channel_logout_supported": true,
  "front_channel_logout_session_supported": true,
  "op_policy_uri": "http://<policy_uri>",
  "op_tos_uri": "http://<tos_uri>"
}