Call AddClientIdToOIDCProvider to add a client ID to an OIDC provider - Resource Access Management - Alibaba Cloud - Resource Access Management

Calls AddClientIdToOIDCProvider to add a specified client ID to an OIDC IdP.

Operation description

Usage notes

This topic provides an example on how to add client ID 598469743454717**** to the OIDC IdP named TestOIDCProvider.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ram:AddClientIdToOIDCProvider

create

*OIDCProvider

acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}

ram:OidcIssuerUrl

None

Request parameters

Parameter	Type	Required	Description	Example
OIDCProviderName	string	No	The name of the OIDC IdP.	TestOIDCProvider
ClientId	string	No	The specified client ID. Format: letters, digits, and the special characters `.-_:/` are allowed. The value cannot start with the special characters `.-_:/`. Length: up to 128 characters.	598469743454717****

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B49B8FA7-87FC-5308-AE75-5EC9E36C360A
OIDCProvider	object	The information about the OIDC IdP.
UpdateDate	string	The time when the OIDC IdP was modified. The time is displayed in UTC.	2021-11-12T08:38:29Z
Description	string	The description of the OIDC IdP.	This is a new OIDC Provider.
OIDCProviderName	string	The name of the OIDC IdP.	TestOIDCProvider
CreateDate	string	The time when the OIDC IdP was created. The time is displayed in UTC.	2021-11-11T06:56:03Z
Arn	string	The Alibaba Cloud Resource Name (ARN) of the OIDC IdP.	acs:ram::177242285274****:oidc-provider/TestOIDCProvider
IssuerUrl	string	The issuer URL.	https://xxxxxx.example.com
Fingerprints	string	The verification fingerprints of the HTTPS CA certificate. Multiple fingerprints are separated by commas (,).	902ef2deeb3c5b13ea4c3d5193629309e231****
ClientIds	string	The client IDs. Multiple client IDs are separated by commas (,).	498469743454717**,598469743454717**
GmtCreate	string	The time when the OIDC IdP was created. The value is a UNIX timestamp.	1636613763000
GmtModified	string	The time when the OIDC IdP was modified. The value is a UNIX timestamp.	1636706309000
IssuanceLimitTime	integer	The earliest time when an external IdP is allowed to issue an ID token. If the value of the iat field in the ID token is greater than the current time by more than this value, the request is rejected. Unit: hours. Valid values: 1 to 168.	12

Examples

Success response

JSON format

{
  "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://xxxxxx.example.com",
    "Fingerprints": "902ef2deeb3c5b13ea4c3d5193629309e231****",
    "ClientIds": "498469743454717****,598469743454717****",
    "GmtCreate": "1636613763000",
    "GmtModified": "1636706309000",
    "IssuanceLimitTime": 12
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.