Patch

/oidcs/{id}/refresh_keys

This endpoint refreshes the keys from OIDC provider.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

integerRequired

OIDC ID

Responses

200

object

OpenID Connect

id

integer

ID

guid

string

Globally unique identifier

name

string

Name

state

string

State of the OIDC provider.

Valid values[ "OK", "INTERNAL_ERROR", "PROVIDER_ACCESS_FAILURE" ]

discovery_url

string

The URL for the discovery JSON for the provider. This provides metadata about the OIDC provider.

assigned_tenants_preview

string

user_jwt_attribute

string

A user attribute in the JWT that is used for audit records. The value of this attribute will be added to audit records to indicate the user. Specify a single attribute (optional). Examples: email, name, preferred_username.

last_keys_refresh_time

string

The time when the access keys for the OIDC provider were last refreshed.

verify_peer

boolean

If true, certificate verification of the OIDC provider (peer) is required. The provider is only trusted to handle requests after the certificate is verified. Uses the certificate specified by the certificate property.

certificate

string

Certificate for verifying the OIDC provider, used if verify_peer is enabled.

Refresh the keys from OIDC provider