orgs

Update a specific OpenID Connect provider setting for the org.

Update a specific OpenID Connect provider setting for the org.

put/orgs/{org}/openid-connect/{slug_perm}/

Request body

claimsobject required

The set of claims that any received tokens from the provider must contain to authenticate as the configured service account.

enabledboolean required

Whether the provider settings should be used for incoming OIDC requests.

mapping_claimstring nullable

The OIDC claim to use for mapping to service accounts in dynamic_mappings. Cannot be provided if service_accounts is also set.

Note: This field and the dynamic mappings feature are still in early access. Breaking changes are possible as we receive feedback on this feature.

namestring required

The name of the provider settings are being configured for

provider_urlstring uri required

The URL from the provider that serves as the base for the OpenID configuration. For example, if the OpenID configuration is available at https://token.actions.githubusercontent.com/.well-known/openid-configuration, the provider URL would be https://token.actions.githubusercontent.com/

service_accountsstring[]

The service accounts associated with these provider settings. Cannot be provided if mapping_claim or dynamic_mappings are specified.

Response

Updated the specified OpenID Connect provider setting for the org

claimsobject required

The set of claims that any received tokens from the provider must contain to authenticate as the configured service account.

enabledboolean required

Whether the provider settings should be used for incoming OIDC requests.

mapping_claimstring nullable

The OIDC claim to use for mapping to service accounts in dynamic_mappings. Cannot be provided if service_accounts is also set.

Note: This field and the dynamic mappings feature are still in early access. Breaking changes are possible as we receive feedback on this feature.

namestring required

The name of the provider settings are being configured for

provider_urlstring uri required

The URL from the provider that serves as the base for the OpenID configuration. For example, if the OpenID configuration is available at https://token.actions.githubusercontent.com/.well-known/openid-configuration, the provider URL would be https://token.actions.githubusercontent.com/

service_accountsstring[]

The service accounts associated with these provider settings. Cannot be provided if mapping_claim or dynamic_mappings are specified.

slugstring slug

The slug of the provider settings

slug_permstring slug

The unique, immutable identifier of the provider settings.

Changes

No recorded changes to this endpoint across all 1 revision of this API.