DocsICP FilingConsole
Documentation

GetFederatedCredentialProvider

Updated at:
Copy as MD
Product
My Favorites

Retrieve a federated credential provider.

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

eiam:GetFederatedCredentialProvider

get

*FederatedCredentialProvider

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
InstanceId

string

Yes

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx
FederatedCredentialProviderId

string

Yes

The federated credential provider ID.

fcp_mkv7rgt4d7i4u7zqtzev2mxxxx

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

0441BD79-92F3-53AA-8657-F8CE4A2B912A
FederatedCredentialProvider

object

The federated credential provider.

InstanceId

string

The ID of the EIAM instance.

idaas_qlbbighyxbu42xl7eninojXXX
FederatedCredentialProviderId

string

The ID of the federated credential provider.

fcp_asd123XXX
FederatedCredentialProviderName

string

The name of the federated credential provider.

test
FederatedCredentialProviderType

string

The type of the federated credential provider.

pkcs7
Description

string

The description.

test
NetworkAccessEndpointId

string

The ID of the network access endpoint.

inae_public
Status

string

The status of the federated credential provider.

enabled
CreateTime

integer

The time when the provider was created.

1729061324000
UpdateTime

integer

The time when the provider was last updated.

1729061324000

OidcProviderConfig

object

The OpenID Connect (OIDC) configuration.

JwksSource

string

The source of the JSON Web Key Set (JWKS).

static
JwksUri

string

The JWKS endpoint.

https://example.com
StaticJwks

string

The static JWKS content.

{ "keys": [ { "kty": "RSA", "e": "AQAB", "use": "sig", "kid": "KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv", "n": "qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX" } ] }
Audiences

array

A list of audiences for the OIDC credential.

string

An audience.

https://example.com
Issuer

string

The issuer of the OIDC credential.

http://test.idaas.com/v2/oauth
TrustCondition

string

The trust condition for the OIDC provider.

IsNullOrEmpty("jwt.issuer")

DynamicJwks

string

The dynamically obtained JWKS.

https://example.com
JwksLastObtainedTime

integer

The time of the last JWKS retrieval.

1729061324000
Pkcs7ProviderConfig

object

The PKCS#7 configuration.

TrustAnchorSource

string

The source of the certificate trust anchor.

alibaba_cloud
Certificates

array<object>

A list of PKCS#7 certificates.

array<object>

A certificate from the list.

Fingerprint

string

The fingerprint of the certificate.

2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx
Content

string

The content of the certificate.

-----BEGIN CERTIFICATE----- MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z -----END CERTIFICATE-----
CertificateMetadata

object

The certificate metadata.

NotBefore

integer

The time when the certificate becomes valid.

1729061324000
NotAfter

integer

The time when the certificate expires.

1729061324000
TrustCondition

string

The trust condition for the PKCS#7 provider.

IsNullOrEmpty("certNo")
CmsVerificationMode

string

The Cryptographic Message Syntax (CMS) verification mode.

cert
SigningTimeValueExpression

string

An expression that specifies the signing time.

pkcs7.payload.jsonData.audience.signingTime
SignatureEffectiveTime

integer

The validity period of the signature, in seconds.

3600
PrivateCaProviderConfig

object

The private certificate authority (CA) configuration.

TrustAnchorSource

string

The method for obtaining the root certificate.

custom
Certificates

array<object>

A list of root certificates.

array<object>

A root certificate.

Fingerprint

string

The fingerprint of the root certificate.

2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx
Content

string

The content of the root certificate.

-----BEGIN CERTIFICATE----- MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z -----END CERTIFICATE-----
CertificateMetadata

object

The certificate metadata.

NotBefore

integer

The time when the certificate becomes valid.

1729061324000
NotAfter

integer

The time when the certificate expires.

1729061324000
TrustCondition

string

The trust condition for the root certificate.

IsNullOrEmpty("certNo")
CloudIdPProviderConfig

object

IdentityProviderId

string

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "FederatedCredentialProvider": {
    "InstanceId": "idaas_qlbbighyxbu42xl7eninojXXX",
    "FederatedCredentialProviderId": "fcp_asd123XXX",
    "FederatedCredentialProviderName": "test",
    "FederatedCredentialProviderType": "pkcs7",
    "Description": "test",
    "NetworkAccessEndpointId": "inae_public",
    "Status": "enabled",
    "CreateTime": 1729061324000,
    "UpdateTime": 1729061324000,
    "OidcProviderConfig": {
      "JwksSource": "static",
      "JwksUri": "https://example.com",
      "StaticJwks": "{\n  \"keys\": [\n    {\n      \"kty\": \"RSA\",\n      \"e\": \"AQAB\",\n      \"use\": \"sig\",\n      \"kid\": \"KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv\",\n      \"n\": \"qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX\"\n    }\n  ]\n}",
      "Audiences": [
        "https://example.com"
      ],
      "Issuer": "http://test.idaas.com/v2/oauth",
      "TrustCondition": "IsNullOrEmpty(\"jwt.issuer\")\n",
      "DynamicJwks": "https://example.com",
      "JwksLastObtainedTime": 1729061324000
    },
    "Pkcs7ProviderConfig": {
      "TrustAnchorSource": "alibaba_cloud",
      "Certificates": [
        {
          "Fingerprint": "2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx",
          "Content": "-----BEGIN CERTIFICATE-----\nMIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z\n-----END CERTIFICATE-----",
          "CertificateMetadata": {
            "NotBefore": 1729061324000,
            "NotAfter": 1729061324000
          }
        }
      ],
      "TrustCondition": "IsNullOrEmpty(\"certNo\")",
      "CmsVerificationMode": "cert",
      "SigningTimeValueExpression": "pkcs7.payload.jsonData.audience.signingTime",
      "SignatureEffectiveTime": 3600
    },
    "PrivateCaProviderConfig": {
      "TrustAnchorSource": "custom",
      "Certificates": [
        {
          "Fingerprint": "2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx",
          "Content": "-----BEGIN CERTIFICATE-----\nMIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z\n-----END CERTIFICATE-----",
          "CertificateMetadata": {
            "NotBefore": 1729061324000,
            "NotAfter": 1729061324000
          }
        }
      ],
      "TrustCondition": "IsNullOrEmpty(\"certNo\")"
    },
    "CloudIdPProviderConfig": {
      "IdentityProviderId": ""
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.