All Products
Search
Document Center

Resource Access Management:AddClientIdToOIDCProvider

Last Updated:May 08, 2024

Adds a client ID to an OpenID Connect (OIDC) identity provider (IdP).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
OIDCProviderNamestringYes

The name of the OIDC IdP.

TestOIDCProvider
ClientIdstringYes

The client ID that you want to add.

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.

598469743454717****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

B49B8FA7-87FC-5308-AE75-5EC9E36C360A
OIDCProviderobject

The information about the OIDC IdP.

UpdateDatestring

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

2021-11-12T08:38:29Z
Descriptionstring

The description of the OIDC IdP.

This is a new OIDC Provider.
OIDCProviderNamestring

The name of the OIDC IdP.

TestOIDCProvider
CreateDatestring

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

2021-11-11T06:56:03Z
Arnstring

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

acs:ram::177242285274****:oidc-provider/TestOIDCProvider
IssuerUrlstring

The URL of the issuer.

https://dev-xxxxxx.okta.com
Fingerprintsstring

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

902ef2deeb3c5b13ea4c3d5193629309e231****
ClientIdsstring

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

498469743454717****,598469743454717****
GmtCreatestring

The timestamp when the OIDC IdP was created.

1636613763000
GmtModifiedstring

The timestamp when the OIDC IdP was modified.

1636706309000
IssuanceLimitTimelong

The earliest time when an external IdP can issue an ID token. If the value of the iat field in the ID token is later than the current time, the request is rejected. Unit: hours. Valid values: 1 to 168.

12

Examples

Sample success responses

JSONformat

{
  "RequestId": "B49B8FA7-87FC-5308-AE75-5EC9E36C360A",
  "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****,598469743454717****",
    "GmtCreate": "1636613763000",
    "GmtModified": "1636706309000",
    "IssuanceLimitTime": 12
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-20The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.