Actualizar el proveedor de identidad de la organización

Actualiza los detalles de un Proveedor de identidad especificado por ID de esta Organización.

PATCH /identity-providers/{idp_id}

Actualizar un proveedor de identidad

cURL

curl --request PATCH \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assign_membership_on_login": false,
  "display_name": "OIDC IdP",
  "is_enabled": true,
  "options": {
    "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
    "client_secret": "KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp",
    "discovery_url": "https://{yourDomain}/.well-known/openid-configuration",
    "type": "front_channel"
  },
  "show_as_button": true
}
'

200

updateIdPResponseExample

{ "access_level": "full", "assign_membership_on_login": false, "attributes": [ { "description": "Nombre de usuario preferido", "is_extra": false, "is_missing": false, "is_required": true, "label": "Preferred username", "sso_field": [ "userName" ], "user_attribute": "preferred_username" }, { "is_extra": true, "is_missing": false, "is_required": true, "sso_field": [ "externalId" ], "user_attribute": "external_id" } ], "display_name": "OIDC IdP", "domains": [ "mydomain.com" ], "id": "con_zW1UHutvkVWSWdCC", "is_enabled": true, "name": "oidcIdp", "options": { "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d", "discovery_url": "https://{yourDomain}/.well-known/openid-configuration", "type": "front_channel" }, "show_as_button": true, "strategy": "oidc" }

Autorizaciones

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de ruta

idp_id · string · requerido · read-only

Identificador del proveedor de identidad.

Pattern: ^con_[A-Za-z0-9]{16}$

Cuerpo

application/json

IdP ADFS Update Request

IdP Google Workforce Update Request

IdP OIDC Update Request

IdP Okta Update Request

IdP Ping Update Request

IdP SAML Update Request

IdP Microsoft Azure AD Update Request

assign_membership_on_login · boolean

Si es true, el usuario pasará a ser miembro de la organización al iniciar sesión. Requiere que access_level sea 'full' o 'limited'.

display_name · string

Nombre del proveedor de identidad usado en la pantalla de inicio de sesión. Requiere que access_level sea 'full'

Required string length: 1 - 128

is_enabled · boolean

True si el proveedor de identidad está habilitado para la organización. Requiere que access_level sea 'full' o 'limited'

show_as_button · boolean

Permite mostrar un botón para la conexión en la página de inicio de sesión (solo en la nueva experiencia). Si es false, solo podrá usarse mediante Home Realm Discovery (HRD). Requiere que access_level sea 'full' o 'limited'

options · adfs_server · object

Opciones específicas del proveedor de identidad. Requiere que access_level sea 'full'.

adfs_server

fedMetadataXml

Show child attributes

Respuesta

200

application/json

El proveedor de identidad se actualizó correctamente.

IdP ADFS Response

IdP Google Workforce Response

IdP OIDC Response

IdP Okta Response

IdP Ping Response

IdP SAML Response

IdP Microsoft Azure AD Response

Opciones específicas del proveedor de identidad.

strategy · enum<string> · requerido

El tipo de proveedor de identidad

Opciones disponibles: adfs, google-apps, oidc, okta, pingfederate, samlp, waad

Allowed value: "adfs"

options · adfs_server · object · requerido

Opciones específicas del proveedor de identidad.

adfs_server

fedMetadataXml

Show child attributes

access_level · enum<string> · read-only

Opciones disponibles: none, readonly, limited, full

assign_membership_on_login · boolean

Si es true, el usuario pasará a ser miembro de la organización al iniciar sesión.

display_name · string

Nombre del proveedor de identidad usado en la pantalla de inicio de sesión.

Required string length: 1 - 128

domains · string[]

Lista de dominios para Home Realm Discovery (HRD)

id · string · read-only

Identificador del proveedor de identidad.

Pattern: ^con_[A-Za-z0-9]{16}$

is_enabled · boolean

True si el proveedor de identidad está habilitado para la organización.

name · string | null

El nombre del proveedor de identidad

Maximum string length: 128

show_as_button · boolean

Permite mostrar un botón para la conexión en la página de inicio de sesión (solo en la nueva experiencia). Si es false, solo podrá usarse mediante Home Realm Discovery (HRD).