Sign in
Identity Providers (iam/v2)

Update an Identity Provider

General Availability

Make a request to update an identity provider.

patch/iam/v2/identity-providers/{id}

Path parameters

idstring required

The unique identifier for the identity provider.

Request body

api_version'iam/v2'

APIVersion defines the schema version of this representation of a resource.

kind'IdentityProvider'

Kind defines the object this REST resource represents.

idstring

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring

The human-readable name of the OAuth identity provider.

descriptionstring

A description of the identity provider.

identity_claimstring

The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from Registered Claim Names. This appears in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity claim configured with that pool will be used instead. Note - The attribute is in an [Early Access lifecycle stage] (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)

statestring

The current state of the identity provider.

issuerstring uri

A publicly accessible URL uniquely identifying the OAuth identity provider authorized to issue access tokens.

jwks_uristring uri

A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth identity provider. JWKS provides a set of crypotgraphic keys used to verify the authenticity and integrity of JSON Web Tokens (JWTs) issued by the OAuth identity provider.

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/identity-providers/ip-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/identity-provider=ip-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "My OIDC Provider",
  "identity_claim": "claims.sub",
  "state": "ENABLED",
  "issuer": "https://login.microsoftonline.com/{tenantid}/v2.0",
  "jwks_uri": "https://login.microsoftonline.com/common/discovery/v2.0/keys",
  "keys": [
    {
      "kty": "RSA",
      "kid": "nOo3ZDrODXEK1jKWhXslHR_KXEg",
      "alg": "RS256",
      "use": "sig",
      "e": "AQAB"
    }
  ]
}

Response

Identity Provider.

api_version'iam/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'IdentityProvider' required

Kind defines the object this REST resource represents.

idstring required

ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").

display_namestring required

The human-readable name of the OAuth identity provider.

descriptionstring required

A description of the identity provider.

identity_claimstring

The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from Registered Claim Names. This appears in audit log records. Note: if the client specifies mapping to one identity pool ID, the identity claim configured with that pool will be used instead. Note - The attribute is in an [Early Access lifecycle stage] (https://docs.confluent.io/cloud/current/api.html#section/Versioning/API-Lifecycle-Policy)

statestring required

The current state of the identity provider.

issuerstring uri required

A publicly accessible URL uniquely identifying the OAuth identity provider authorized to issue access tokens.

jwks_uristring uri required

A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth identity provider. JWKS provides a set of crypotgraphic keys used to verify the authenticity and integrity of JSON Web Tokens (JWTs) issued by the OAuth identity provider.

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/identity-providers/ip-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/identity-provider=ip-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "My OIDC Provider",
  "identity_claim": "claims.sub",
  "state": "ENABLED",
  "issuer": "https://login.microsoftonline.com/{tenantid}/v2.0",
  "jwks_uri": "https://login.microsoftonline.com/common/discovery/v2.0/keys",
  "keys": [
    {
      "kty": "RSA",
      "kid": "nOo3ZDrODXEK1jKWhXslHR_KXEg",
      "alg": "RS256",
      "use": "sig",
      "e": "AQAB"
    }
  ]
}

Changes

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