Crea un proveedor de identidad dentro de la federación especificada. Para usar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de propietario de la organización en una de las organizaciones conectadas.
Nota: Este recurso solo admite la creación de proveedores de identidad OIDC.
Parámetros de ruta
-
Cadena de dígitos hexadecimales 24única que identifica su federación.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false.
POST /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders
Atlas CLI
atlas api federatedAuthentication createIdentityProvider --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateFederationSettingIdentityProviderApiParams{}
sdkResp, httpResp, err := client.FederatedAuthenticationApi.
CreateFederationSettingIdentityProviderWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \
-d '{ <Payload> }'
Solicitar ejemplos
Fuerza laboral de Oidc
{
"audience": "string",
"authorizationType": "GROUP",
"description": "string",
"displayName": "string",
"groupsClaim": "string",
"idpType": "WORKFORCE",
"issuerUri": "urn:idp:default",
"protocol": "SAML",
"userClaim": "string",
"associatedDomains": [
"string"
],
"clientId": "string",
"requestedScopes": [
"string"
]
}{
"audience": "string",
"authorizationType": "GROUP",
"description": "string",
"displayName": "string",
"groupsClaim": "string",
"idpType": "WORKFORCE",
"issuerUri": "urn:idp:default",
"protocol": "SAML",
"userClaim": "string"
}
Ejemplos de respuestas (200)
Fuerza laboral de Oidc
{
"associatedOrgs": [
{
"dataAccessIdentityProviderIds": [
"string"
],
"domainAllowList": [
"string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": [
"ORG_OWNER"
],
"roleMappings": [
{
"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "string"
}
]
}
],
"userConflicts": [
{
"emailAddress": "hello@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "32b6e34b3d91647abb20e7b8"
}
]
}
],
"audience": "string",
"authorizationType": "GROUP",
"createdAt": "2026-05-04T09:42:00Z",
"description": "string",
"displayName": "string",
"groupsClaim": "string",
"id": "32b6e34b3d91647abb20e7b8",
"idpType": "WORKFORCE",
"issuerUri": "string",
"oktaIdpId": "string",
"protocol": "SAML",
"updatedAt": "2026-05-04T09:42:00Z",
"userClaim": "string",
"associatedDomains": [
"string"
],
"clientId": "string",
"requestedScopes": [
"string"
]
}{
"associatedOrgs": [
{
"dataAccessIdentityProviderIds": [
"string"
],
"domainAllowList": [
"string"
],
"domainRestrictionEnabled": true,
"identityProviderId": "string",
"orgId": "32b6e34b3d91647abb20e7b8",
"postAuthRoleGrants": [
"ORG_OWNER"
],
"roleMappings": [
{
"externalGroupName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"roleAssignments": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"role": "string"
}
]
}
],
"userConflicts": [
{
"emailAddress": "hello@example.com",
"federationSettingsId": "32b6e34b3d91647abb20e7b8",
"firstName": "string",
"lastName": "string",
"userId": "32b6e34b3d91647abb20e7b8"
}
]
}
],
"audience": "string",
"authorizationType": "GROUP",
"createdAt": "2026-05-04T09:42:00Z",
"description": "string",
"displayName": "string",
"groupsClaim": "string",
"id": "32b6e34b3d91647abb20e7b8",
"idpType": "WORKFORCE",
"issuerUri": "string",
"oktaIdpId": "string",
"protocol": "SAML",
"updatedAt": "2026-05-04T09:42:00Z",
"userClaim": "string"
}
Ejemplos de respuestas (400)
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
Ejemplos de respuestas (401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}