Queries OpenID Connect (OIDC) identity providers (IdPs).

Description

This topic provides an example on how to query all OIDC IdPs within your Alibaba Cloud account. The response shows that your Alibaba Cloud account has only one OIDC IdP named TestOIDCProvider.

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 ListOIDCProviders

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

Marker String No EXAMPLE

The marker. If part of a previous response is truncated, you can use this parameter to obtain the truncated part.

MaxItems Integer No 100

The number of entries to return. If a response is truncated because it reaches the value of MaxItems, the value of IsTruncated will be true.

Valid values: 1 to 100. Default value: 100.

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

Response parameters

Parameter Type Example Description
RequestId String D2148337-B86A-57F0-8B31-EB7BE0125226

The ID of the request.

OIDCProviders Array of OIDCProvider

The information about the OIDC IdP.

OIDCProvider
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.

IsTruncated Boolean false

Indicates whether the response is truncated. Valid values:

  • true
  • false
Marker String EXAMPLE

The marker. This parameter is returned only if the value of IsTruncated is true. If the parameter is returned, you can call this operation again and set this parameter to obtain the truncated part.

Examples

Sample requests

https://[Endpoint]/?Action=ListOIDCProviders
&Common request parameters

Sample success responses

XML format

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

<ListOIDCProvidersResponse>
    <RequestId>D2148337-B86A-57F0-8B31-EB7BE0125226</RequestId>
    <OIDCProviders>
        <OIDCProvider>
            <GmtCreate>1636613763000</GmtCreate>
            <Description>This is a new OIDC Provider.</Description>
            <OIDCProviderName>TestOIDCProvider</OIDCProviderName>
            <IssuerUrl>https://dev-xxxxxx.okta.com</IssuerUrl>
            <Fingerprints>902ef2deeb3c5b13ea4c3d5193629309e231****</Fingerprints>
            <GmtModified>1636706309000</GmtModified>
            <Arn>acs:ram::177242285274****:oidc-provider/TestOIDCProvider</Arn>
            <ClientIds>498469743454717****</ClientIds>
            <UpdateDate>2021-11-12T08:38:29Z</UpdateDate>
            <CreateDate>2021-11-11T06:56:03Z</CreateDate>
        </OIDCProvider>
    </OIDCProviders>
    <IsTruncated>false</IsTruncated>
</ListOIDCProvidersResponse>

JSON format

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

{
  "RequestId" : "D2148337-B86A-57F0-8B31-EB7BE0125226",
  "OIDCProviders" : {
    "OIDCProvider" : [ {
      "GmtCreate" : 1636613763000,
      "Description" : "This is a new OIDC Provider.",
      "OIDCProviderName" : "TestOIDCProvider",
      "IssuerUrl" : "https://dev-xxxxxx.okta.com",
      "Fingerprints" : "902ef2deeb3c5b13ea4c3d5193629309e231****",
      "GmtModified" : 1636706309000,
      "Arn" : "acs:ram::177242285274****:oidc-provider/TestOIDCProvider",
      "ClientIds" : "498469743454717****",
      "UpdateDate" : "2021-11-12T08:38:29Z",
      "CreateDate" : "2021-11-11T06:56:03Z"
    } ]
  },
  "IsTruncated" : false
}

Error codes

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