Modifies the description and client IDs of an OpenID Connect (OIDC) identity provider (IdP).

Description

This topic provides an example on how to change the description of the OIDC IdP named TestOIDCProvider to This is a new OIDC Provider.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateOIDCProvider

The operation that you want to perform. Set the value to UpdateOIDCProvider.

OIDCProviderName String Yes TestOIDCProvider

The name of the OIDC IdP.

ClientIds String No 498469743454717****

The ID of the client. If you want to specify multiple fingerprints, separate the fingerprints with commas (,).

The client ID can contain letters, digits, and special characters and cannot start with the special characters. The special characters are periods, (.), hyphens (-), underscores (_), colons (:), and forward slashes (/).

The client ID can be up to 64 characters in length.

Note If you specify this parameter, all the client IDs of the OIDC IdP are replaced. If you need to only add or remove a client ID, call the AddClientIdToOIDCProvider or RemoveClientIdFromOIDCProvider operation. For more information, see AddClientIdToOIDCProvider or RemoveClientIdFromOIDCProvider.
NewDescription String No This is a new OIDC Provider.

The description of the OIDC IdP.

The description can be up to 256 characters in length.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String E4C4D1BD-2558-5BD1-8C26-A5D7FB174A55

The ID of the request.

OIDCProvider Object

The information about the OIDC IdP.

UpdateDate String 2021-11-12T08:38:29Z

The time when the OIDC IdP was modified. The time is displayed in UTC.

Description String This is a new OIDC Provider.

The description of the OIDC IdP.

OIDCProviderName String TestOIDCProvider

The name of the OIDC IdP.

CreateDate String 2021-11-11T06:56:03Z

The time when the OIDC IdP was created. The time is displayed in UTC.

Arn String acs:ram::177242285274****:oidc-provider/TestOIDCProvider

The Alibaba Cloud Resource Name (ARN) of the OIDC IdP.

IssuerUrl String https://dev-xxxxxx.okta.com

The URL of the issuer.

Fingerprints String 902ef2deeb3c5b13ea4c3d5193629309e231****

The fingerprint of the HTTPS certificate. If multiple fingerprints are returned, the fingerprints are separated by commas (,).

ClientIds String 498469743454717****

The ID of the client. If multiple client IDs are returned, the client IDs are separated by commas (,).

GmtCreate String 1636613763000

The timestamp when the OIDC IdP was created.

GmtModified String 1636706309000

The timestamp when the OIDC IdP was modified.

Examples

Sample requests

https://[Endpoint]/?Action=UpdateOIDCProvider
&OIDCProviderName=TestOIDCProvider
&NewDescription=This is a new OIDC Provider.
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateOIDCProviderResponse>
    <RequestId>E4C4D1BD-2558-5BD1-8C26-A5D7FB174A55</RequestId>
    <OIDCProvider>
        <UpdateDate>2021-11-12T08:38:29Z</UpdateDate>
        <Description>This is a new OIDC Provider.</Description>
        <OIDCProviderName>TestOIDCProvider</OIDCProviderName>
        <CreateDate>2021-11-11T06:56:03Z</CreateDate>
        <Arn>acs:ram::177242285274****:oidc-provider/TestOIDCProvider</Arn>
        <IssuerUrl>https://dev-xxxxxx.okta.com</IssuerUrl>
        <Fingerprints>902ef2deeb3c5b13ea4c3d5193629309e231****</Fingerprints>
        <ClientIds>498469743454717****</ClientIds>
        <GmtCreate>1636613763000</GmtCreate>
        <GmtModified>1636706309000</GmtModified>
    </OIDCProvider>
</UpdateOIDCProviderResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E4C4D1BD-2558-5BD1-8C26-A5D7FB174A55",
  "OIDCProvider" : {
    "UpdateDate" : "2021-11-12T08:38:29Z",
    "Description" : "This is a new OIDC Provider.",
    "OIDCProviderName" : "TestOIDCProvider",
    "CreateDate" : "2021-11-11T06:56:03Z",
    "Arn" : "acs:ram::177242285274****:oidc-provider/TestOIDCProvider",
    "IssuerUrl" : "https://dev-xxxxxx.okta.com",
    "Fingerprints" : "902ef2deeb3c5b13ea4c3d5193629309e231****",
    "ClientIds" : "498469743454717****",
    "GmtCreate" : "1636613763000",
    "GmtModified" : "1636706309000"
  }
}

Error codes

For a list of error codes, visit the API Error Center.