REST API for Oracle Identity Cloud Service

Retrieve IDCS Discovery Doc

get

/.well-known/idcs-configuration

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

IDCS configuration.

Example Response (application/json)

{
    "configuration":{
        "version":"1",
        "service_release_version":"0.1.0-dev-local"
    },
    "access-configuration":{
        "http_authentication_endpoint":"/admin/v1/HTTPAuthenticator",
        "encryption_keys_endpoint":"/admin/v1/EncryptionKeys",
        "password_authenticator_endpoint":"/admin/v1/PasswordAuthenticator",
        "asserter_endpoint":"/admin/v1/Asserter"
    },
    "openid-configuration":{
        "response_types_supported":[
            "code",
            "token",
            "id_token",
            "code token",
            "code id_token",
            "token id_token",
            "code token id_token"
        ],
        "id_token_signing_alg_values_supported":[
            "RS256"
        ],
        "scopes_supported":[
            "openid",
            "profile",
            "offline_access",
            "email",
            "address",
            "phone",
            "groups",
            "get_groups",
            "approles",
            "get_approles"
        ],
        "issuer":"https://identity.oraclecloud.com/",
        "userinfo_signing_alg_values_supported":[
            "none"
        ],
        "revocation_endpoint":"/oauth2/v1/revoke",
        "claims_supported":[
            "aud",
            "exp",
            "iat",
            "iss",
            "jti",
            "sub"
        ],
        "token_endpoint_auth_signing_alg_values_supported":[
            "RS256"
        ],
        "request_parameter_supported":false,
        "introspect_endpoint":"/oauth2/v1/introspect",
        "subject_types_supported":[
            "public"
        ],
        "authorization_endpoint":"/oauth2/v1/authorize",
        "token_endpoint_auth_methods_supported":[
            "client_secret_basic",
            "client_secret_jwt"
        ],
        "request_uri_parameter_supported":false,
        "claims_parameter_supported":false,
        "end_session_endpoint":"/oauth2/v1/userlogout",
        "ui_locales_supported":[
            "en"
        ],
        "userinfo_endpoint":"/oauth2/v1/userinfo",
        "token_endpoint":"/oauth2/v1/token",
        "jwks_uri":"/admin/v1/SigningCert/jwk",
        "logout_session_supported":false,
        "require_request_uri_registration":false,
        "http_logout_supported":true,
        "grant_types_supported":[
            "client_credentials",
            "password",
            "refresh_token",
            "authorization_code",
            "urn:ietf:params:oauth:grant-type:jwt-bearer"
        ]
    },
    "saml-configuration":{
        "saml_sp_sso_endpoint":"/fed/v1/sp/sso",
        "assertion_consumer_service_bindings_supported":[
            "HTTP-POST"
        ],
        "sp_initiate_sso_endpoint":"/fed/v1/sp/initiatesso",
        "metadata_endpoint":"/fed/v1/metadata",
        "sso_service_bindings_supported":[
            "HTTP-Redirect",
            "HTTP-POST"
        ],
        "idp_initiate_sso_endpoint":"/fed/v1/idp/initiatesso",
        "encryption_alg_values_supported":[
            "aes128-cbc",
            "aes192-cbc",
            "aes256-cbc",
            "tripledes-cbc"
        ],
        "signature_alg_values_supported":[
            "rsa-sha1",
            "rsa-sha256"
        ],
        "saml_sp_logout_endpoint":"/fed/v1/sp/slo",
        "saml_idp_logout_endpoint":"/fed/v1/idp/slo",
        "saml_idp_sso_endpoint":"/fed/v1/idp/sso",
        "logout_service_bindings_supported":[
            "HTTP-Redirect",
            "HTTP-POST"
        ]
    },
    "scim-configuration":{
        "scim_resource_types_endpoint":"/admin/v1/ResourceTypes",
        "scim_schemas_endpoint":"/admin/v1/Schemas",
        "scim_service_provider_config_endpoint":"/admin/v1/ServiceProviderConfig",
        "scim_users_endpoint":"/admin/v1/Users",
        "scim_groups_endpoint":"/admin/v1/Groups"
    }
}

Examples

The following example shows how to retrieve the Identity Cloud Service discovery documentation by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

Note:

The command in this example uses the URL structure https://tenant-base-url/resource-path, where tenant-base-url represents the Identity Service URL, and the resource path represents the Identity Service API. See Send Requests for the appropriate URL structure to use.

curl
-k
-X GET
-H "Content-Type:text/html"
-H "Authorization: Bearer <Access Token Value>"
https://tenant-base-url/.well-known/idcs-configuration

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "configuration": {
    "version": "1",
    "service_release_version": "0.1.0-dev-local"
  },
  "access-configuration": {
    "http_authentication_endpoint": "<idcs-base-url>/admin/v1/HTTPAuthenticator",
    "encryption_keys_endpoint": "<idcs-base-url>/admin/v1/EncryptionKeys"
  },
  "openid-configuration": {
    "issuer": "https://identity.oraclecloud.com/",
    "authorization_endpoint": "<idcs-base-url>/oauth2/v1/authorize",
    "token_endpoint": "<idcs-base-url>/oauth2/v1/token",
    "userinfo_endpoint": "<idcs-base-url>/oauth2/v1/userinfo",
    "revocation_endpoint": "<idcs-base-url>/oauth2/v1/revoke",
    "introspect_endpoint": "<idcs-base-url>/oauth2/v1/introspect",
    "end_session_endpoint": "<idcs-base-url>/oauth2/v1/userlogout",
    "jwks_uri": "<idcs-base-url>/admin/v1/SigningCert/jwk",
    "scopes_supported": [
      "openid",
      "profile",
      "offline_access",
      "email",
      "address",
      "phone",
      "groups",
      "get_groups",
      "approles",
      "get_approles"
    ],
    "response_types_supported": [
      "code",
      "token",
      "id_token",
      "code token",
      "code id_token",
      "token id_token",
      "code token id_token"
    ],
    "subject_types_supported": [
      "public"
    ],
    "id_token_signing_alg_values_supported": [
      "RS256"
    ],
    "claims_supported": [
      "aud",
      "exp",
      "iat",
      "iss",
      "jti",
      "sub"
    ],
    "grant_types_supported": [
      "client_credentials",
      "password",
      "refresh_token",
      "authorization_code",
      "urn:ietf:params:oauth:grant-type:jwt-bearer",
      "urn:ietf:params:oauth:grant-type:saml2-bearer"
    ],
    "token_endpoint_auth_methods_supported": [
      "client_secret_basic",
      "client_secret_jwt",
    ],
    "token_endpoint_auth_signing_alg_values_supported": [
      "RS256"
    ],
    "userinfo_signing_alg_values_supported": [
      "none"
    ],
    "ui_locales_supported": [
      "en"
    ],
    "claims_parameter_supported": false,
    "http_logout_supported": true,
    "logout_session_supported": false,
    "request_parameter_supported": false,
    "request_uri_parameter_supported": false,
    "require_request_uri_registration": false
  },
  "saml-configuration": {
    "idp_initiate_sso_endpoint": "<idcs-base-url>/fed/v1/idp/initiatesso",
    "sp_initiate_sso_endpoint": "<idcs-base-url>/fed/v1/sp/initiatesso",
    "metadata_endpoint": "<idcs-base-url>/fed/v1/metadata",
    "saml_idp_sso_endpoint": "<idcs-base-url>/fed/v1/idp/sso",
    "saml_idp_logout_endpoint": "<idcs-base-url>/fed/v1/idp/slo",
    "saml_sp_sso_endpoint": "<idcs-base-url>/fed/v1/sp/sso",
    "saml_sp_logout_endpoint": "<idcs-base-url>/fed/v1/sp/slo",
    "encryption_alg_values_supported": [
      "aes128-cbc",
      "aes192-cbc",
      "aes256-cbc",
      "tripledes-cbc"
    ],
    "signature_alg_values_supported": [
      "rsa-sha1",
      "rsa-sha256"
    ],
    "sso_service_bindings_supported": [
      "HTTP-Redirect",
      "HTTP-POST"
    ],
    "assertion_consumer_service_bindings_supported": [
      "HTTP-POST"
    ],
    "logout_service_bindings_supported": [
      "HTTP-Redirect",
      "HTTP-POST"
    ]
  },
  "scim-configuration": {
    "scim_resource_types_endpoint": "<idcs-base-url>/admin/v1/ResourceTypes",
    "scim_schemas_endpoint": "<idcs-base-url>/admin/v1/Schemas",
    "scim_service_provider_config_endpoint": "<idcs-base-url>/admin/v1/ServiceProviderConfig",
    "scim_users_endpoint": "<idcs-base-url>/admin/v1/Users",
    "scim_groups_endpoint": "<idcs-base-url>/admin/v1/Groups"
  }
}