All Products
Search

This Product

    Resource Access Management:CreateOIDCProvider

    Document Center

    Resource Access Management:CreateOIDCProvider

    Last Updated:Mar 30, 2026

    Creates an OpenID Connect (OIDC) identity provider (IdP) to configure a trust relationship between Alibaba Cloud and an external IdP. This topic provides an example on how to create an IdP named TestOIDCProvider to configure a trust relationship between the external IdP Okta and Alibaba Cloud.

    Operation description

    Prerequisites

    Before you call this operation, make sure that the information such as the URL of the issuer, the fingerprints of HTTPS certificate authority (CA) certificates, and the client IDs are obtained from an external IdP, such as Google Workspace or Okta.

    Limits

    • You can create a maximum of 100 OIDC IdPs in an Alibaba Cloud account.

    • You can add a maximum of 50 client IDs to an OIDC IdP.

    • You can add a maximum of five fingerprints to an OIDC IdP.

    Operation description

    This topic provides an example on how to create an IdP named TestOIDCProvider to configure a trust relationship between the external IdP and Alibaba Cloud.

    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:CreateOIDCProvider

    create

    *All Resource

    *
    • ram:OidcIssuerUrl
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    OIDCProviderName

    string

    No

    The name of the OIDC IdP.

    The name can contain letters, digits, and special characters and cannot start or end with the special characters. The special characters are periods, (.), hyphens (-), and underscores (_).``

    The name can be up to 128 characters in length.

    TestOIDCProvider
    IssuerUrl

    string

    No

    The URL of the issuer, which is provided by the external IdP. The URL of the issuer must be unique within an Alibaba Cloud account.

    The URL of the issuer must start with https and be in the valid URL format. The URL cannot contain query parameters that follow a question mark (?) or logon information that is identified by at signs (@). The URL cannot be a fragment URL that contains number signs (#).

    The URL can be up to 255 characters in length.

    https://xxxxxx.example.com
    Description

    string

    No

    The description of the OIDC IdP.

    The description can be up to 256 characters in length.

    This is an OIDC Provider.
    ClientIds

    string

    No

    The ID of the client, which is provided by the external IdP. If you want to specify multiple client IDs, separate the client IDs 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 128 characters in length.

    498469743454717****
    Fingerprints

    string

    No

    The fingerprint of the HTTPS CA certificate, which is provided by the external IdP. If you want to specify multiple fingerprints, separate the fingerprints with commas (,).

    The fingerprint can contain letters and digits.

    The fingerprint can be up to 128 characters in length.

    902ef2deeb3c5b13ea4c3d5193629309e231****
    IssuanceLimitTime

    integer

    No

    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.

    6

    For more information about common request parameters, see API Reference.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    64B11B41-636D-51E3-A39B-C8703CD2218C
    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-11T06:56:03Z
    Description

    string

    The description of the OIDC IdP.

    This is an 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 URL of the issuer.

    https://xxxxxx.example.com
    Fingerprints

    string

    The fingerprint of the HTTPS certificate.

    902ef2deeb3c5b13ea4c3d5193629309e231****
    ClientIds

    string

    The ID of the client.

    498469743454717****
    GmtCreate

    string

    The timestamp when the OIDC IdP was created.

    1636613763000
    GmtModified

    string

    The timestamp when the OIDC IdP was modified.

    1636613763000
    IssuanceLimitTime

    integer

    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.

    6

    Examples

    Success response

    JSON format

    {
  "RequestId": "64B11B41-636D-51E3-A39B-C8703CD2218C",
  "OIDCProvider": {
    "UpdateDate": "2021-11-11T06:56:03Z",
    "Description": "This is an 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****",
    "GmtCreate": "1636613763000",
    "GmtModified": "1636613763000",
    "IssuanceLimitTime": 6
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.