# Return One Identity Provider by ID

**GET /api/atlas/v1.0/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}**

Returns one SAML identity provider from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations.


## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

#### Path parameters
- **federationSettingsId** (string)
  Unique 24-hexadecimal digit string that identifies your federation.
- **identityProviderId** (string)
  Legacy 20-hexadecimal digit string that identifies the identity provider. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider.

#### Query parameters
- **envelope** (boolean)
  Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.


## Responses
### 200: OK

#### Body Parameters: application/json (object)
- **acsUrl** (string)
  URL that points to where to send the SAML response.
- **associatedDomains** (array[string])
  List that contains the domains associated with the identity provider.
- **associatedOrgs** (array[object])
  List that contains the connected organization configurations associated with the identity provider.
- **audienceUri** (string)
  Unique string that identifies the intended audience of the SAML assertion.
- **createdAt** (string(date-time))
  Date that the identity provider was created on. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- **description** (string)
  The description of the identity provider.
- **displayName** (string)
  Human-readable label that identifies the identity provider.
- **id** (string)
  Unique 24-hexadecimal digit string that identifies the identity provider.
- **idpType** (string)
  String enum that indicates the type of the identity provider. Default is WORKFORCE.
- **issuerUri** (string)
  Unique string that identifies the issuer of the SAML Assertion or OIDC metadata/discovery document URL.
- **oktaIdpId** (string)
  Legacy 20-hexadecimal digit string that identifies the identity provider.
- **pemFileInfo** (object)
  PEM file information for the identity provider's current certificates.
- **protocol** (string)
  String enum that indicates the protocol of the identity provider. Either SAML or OIDC.
- **requestBinding** (string)
  SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.
- **responseSignatureAlgorithm** (string)
  Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.
- **slug** (string)
  Custom SSO Url for the identity provider.
- **ssoDebugEnabled** (boolean)
  Flag that indicates whether the identity provider has SSO debug enabled.
- **ssoUrl** (string)
  URL that points to the receiver of the SAML authentication request.
- **status** (string)
  String enum that indicates whether the identity provider is active.
- **updatedAt** (string(date-time))
  Date that the identity provider was last updated on. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

### 400: Bad Request.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 401: Unauthorized.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403: Forbidden.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404: Not Found.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500: Internal Server Error.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)