CreateFederatedCredentialProvider - Identity as a Service

Creates 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:CreateFederatedCredentialProvider

create

*FederatedCredentialProvider

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
FederatedCredentialProviderName	string	Yes	The name of the federated credential provider.	test
FederatedCredentialProviderType	string	Yes	The type of the federated credential provider.	pkcs7
NetworkAccessEndpointId	string	No	The ID of the network access endpoint.	nae_example_id
Description	string	No	The description of the federated credential provider.	test
PrivateCaProviderConfig	object	No	The configuration of the private certificate authority (CA).
TrustAnchorSource	string	No	The method to obtain the root certificate.	custom
Certificates	array	No	The list of root certificates.
	object	No
Content	string	No	The content of the root certificate.	-----BEGIN CERTIFICATE----- MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z -----END CERTIFICATE-----
TrustCondition	string	No	The trust condition for the root certificate.	IsNullOrEmpty("jwt.issuer")
OidcProviderConfig	object	No	The OpenID Connect (OIDC) configuration.
JwksSource	string	No	The source of the JSON Web Key Set (JWKS).	static
JwksUri	string	No	The JWKS endpoint.	https://example.com/jwks
StaticJwks	string	No	The statically obtained JWKS.	{ "keys": [ { "kty": "RSA", "e": "AQAB", "use": "sig", "kid": "KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv", "n": "qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXXXXX" } ] }
Audiences	array	No	The list of audiences.
	string	No	The audience.	https://www.example.com
TrustCondition	string	No	The trust condition.	IsNullOrEmpty("jwt.issuer")
Issuer	string	No	The issuer.	https://example.com
Pkcs7ProviderConfig	object	No	The PKCS#7 configuration.
TrustAnchorSource	string	No	The source of the certificate trust anchor.	custom
Certificates	array	No	The list of PKCS#7 certificates.
	object	No
Content	string	No	The content of the root certificate.	-----BEGIN CERTIFICATE----- MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z -----END CERTIFICATE-----
TrustCondition	string	No	The trust condition.	IsNullOrEmpty("jwt.issuer")
CmsVerificationMode	string	No	The Cryptographic Message Syntax (CMS) verification mode.	cert_chain
SigningTimeValueExpression	string	No	The expression to obtain the signing time.	pkcs7.signingTime
SignatureEffectiveTime	integer	No	The validity period of the signature.	1200

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
FederatedCredentialProviderId	string	The ID of the federated credential provider.	fcp_sada123XXXX

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "FederatedCredentialProviderId": "fcp_sada123XXXX"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.