OAuthProfile

OAuthProfile

JSON Example

{
    "authorization_endpoint": "string",
    "end_session_endpoint": "string",
    "instance_id": "string",
    "introspection_endpoint": "string",
    "issuer": "string",
    "jwks_timeout": 0,
    "jwks_uri": "string",
    "oauth_controller_settings": {
        "client_id": "string",
        "client_secret": "string",
        "oidc_config": {
            "oidc_enable": false,
            "profile": false,
            "userinfo": false
        },
        "scopes": [
            "string"
        ]
    },
    "oauth_profile_type": "string",
    "oauth_provider": "string",
    "oauth_resp_buffer_sz": 0,
    "org_id": "string",
    "pool_ref": "string",
    "redirect_uri": "string",
    "service_id": "string",
    "service_name": "string",
    "token_endpoint": "string",
    "userinfo_endpoint": "string"
}

string

authorization_endpoint

Required

URL of authorization server. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

end_session_endpoint

Optional

Logout URI of IDP server. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

instance_id

Optional

Instance uuid of the csp service. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

introspection_endpoint

Optional

URL of token introspection server. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

issuer

Optional

Uniquely identifiable name of the Token Issuer. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32

jwks_timeout

Optional

Lifetime of the cached JWKS keys. Allowed values are 0-1440. Field introduced in 21.1.3. Unit is MIN. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

jwks_uri

Optional

JWKS URL of the endpoint that hosts the public keys that can be used to verify any JWT issued by the authorization server. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

OAuthAppSettings

oauth_controller_settings

Optional

oauth_controller_settings

string

oauth_profile_type

Optional

Type of OAuth profile which defines the usage type. Enum options - CLIENT_OAUTH, CONTROLLER_OAUTH. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

oauth_provider

Optional

Type of OAuth Provider when using controller oauth as oauth profile type. Enum options - OAUTH_CSP. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32

oauth_resp_buffer_sz

Optional

Buffering size for the responses from the OAUTH enpoints. Allowed values are 0-32768000. Field introduced in 21.1.3. Unit is BYTES. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

org_id

Optional

Organization Id for OAuth. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

pool_ref

Optional

Pool object to interface with Authorization Server endpoints. It is a reference to an object of type Pool. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

redirect_uri

Optional

Redirect URI specified in the request to Authorization Server. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

service_id

Optional

Uuid value of csp service. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

service_name

Optional

Name of the csp service. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

token_endpoint

Optional

URL of token exchange server. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

userinfo_endpoint

Optional

URL of the Userinfo Endpoint. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Property Of

AuthProfile