Skip to main content
REST API reference

Retrieve the OIDC configuration in the ONTAP cluster

Retrieves the OIDC configuration in the cluster to review the current authentication settings for OIDC integration.

HTTP method and endpoint

GET /security/authentication/cluster/oidc

Introduced in

ONTAP 9.19

  • security oidc show

Parameters

Name Type In Required Description

jwks_refresh_interval

string

query

False

Filter by jwks_refresh_interval

issuer

string

query

False

Filter by issuer

skip_uri_validation

boolean

query

False

Filter by skip_uri_validation

end_session_endpoint

string

query

False

Filter by end_session_endpoint

client_id

string

query

False

Filter by client_id

provider

string

query

False

Filter by provider

remote_user_claim

string

query

False

Filter by remote_user_claim

access_token_issuer

string

query

False

Filter by access_token_issuer

outgoing_proxy

string

query

False

Filter by outgoing_proxy

token_endpoint

string

query

False

Filter by token_endpoint

client_secret

string

query

False

Filter by client_secret

enabled

boolean

query

False

Filter by enabled

redirect_ipaddress

string

query

False

Filter by redirect_ipaddress

provider_jwks_uri

string

query

False

Filter by provider_jwks_uri

authorization_endpoint

string

query

False

Filter by authorization_endpoint

client_secret_hash

string

query

False

Filter by client_secret_hash

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

access_token_issuer

string

The issuer value for the access token when it is different from the OpenID Connect issuer.

authorization_endpoint

string

The URI of the authorization endpoint for the OpenID Connect provider.

client_id

string

The client ID for the application.

client_secret

string

The client secret for the application.

client_secret_hash

string

The hash of the client secret for the application.

enabled

boolean

Indicates whether the OpenID Connect configuration is enabled.

end_session_endpoint

string

The URI of the end session endpoint for the OpenID Connect provider.

issuer

string

The URI of the OpenID Connect provider.

jwks_refresh_interval

string

The refresh interval for the JSON Web Key Set (JWKS), in ISO-8601 format. This can be set to a value from 300 seconds to 2147483647 seconds.

outgoing_proxy

string

Outgoing proxy to access external identity providers (IdPs). If not specified, no proxy is configured.

provider

string

The OpenID Connect provider type.

provider_jwks_uri

string

The URI of the JSON Web Key Set (JWKS) for the OpenID Connect provider.

redirect_ipaddress

string

The IP address to redirect to after authentication.

remote_user_claim

string

The claim used to identify the remote user.

skip_uri_validation

boolean

Indicates whether to skip URI validation.

token_endpoint

string

The URI of the token endpoint for the OpenID Connect provider.

Example response
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "access_token_issuer": "https://example.netapp.com/adfs/services/trust",
  "authorization_endpoint": "https://example.netapp.com/adfs/oauth2/authorize",
  "client_id": "1234567890abcdef",
  "client_secret": "1234567890abcdef1234567890abcdef",
  "client_secret_hash": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "enabled": 1,
  "end_session_endpoint": "https://example.netapp.com/adfs/oauth2/logout",
  "issuer": "https://example.netapp.com/adfs",
  "jwks_refresh_interval": "PT2H",
  "outgoing_proxy": "https://johndoe:secretpass@proxy.example.com:8080",
  "provider": "adfs",
  "provider_jwks_uri": "https://example.netapp.com/adfs/discovery/v2.0/keys",
  "redirect_ipaddress": "10.10.10.10",
  "remote_user_claim": "unique_name",
  "skip_uri_validation": "",
  "token_endpoint": "https://example.netapp.com/adfs/oauth2/token"
}

Error

Status: Default, Error
Name Type Description

error

returned_error

Example error
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

Name Type Description

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.