# GetIdentitySource
<a name="API_GetIdentitySource"></a>

Retrieves the details about the specified identity source.

## Request Syntax
<a name="API_GetIdentitySource_RequestSyntax"></a>

```
{
   "identitySourceId": "string",
   "policyStoreId": "string"
}
```

## Request Parameters
<a name="API_GetIdentitySource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [identitySourceId](#API_GetIdentitySource_RequestSyntax) **   <a name="verifiedpermissions-GetIdentitySource-request-identitySourceId"></a>
Specifies the ID of the identity source you want information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[a-zA-Z0-9-]*`   
Required: Yes

 ** [policyStoreId](#API_GetIdentitySource_RequestSyntax) **   <a name="verifiedpermissions-GetIdentitySource-request-policyStoreId"></a>
Specifies the ID of the policy store that contains the identity source you want information about.  
To specify a policy store, use its ID or alias name. When using an alias name, prefix it with `policy-store-alias/`. For example:  
+ ID: `PSEXAMPLEabcdefg111111` 
+ Alias name: `policy-store-alias/example-policy-store` 
To view aliases, use [ListPolicyStoreAliases](https://docs.amazonaws.cn/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[a-zA-Z0-9-/_]*`   
Required: Yes

## Response Syntax
<a name="API_GetIdentitySource_ResponseSyntax"></a>

```
{
   "configuration": { ... },
   "createdDate": "string",
   "details": { 
      "clientIds": [ "string" ],
      "discoveryUrl": "string",
      "openIdIssuer": "string",
      "userPoolArn": "string"
   },
   "identitySourceId": "string",
   "lastUpdatedDate": "string",
   "policyStoreId": "string",
   "principalEntityType": "string"
}
```

## Response Elements
<a name="API_GetIdentitySource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdDate](#API_GetIdentitySource_ResponseSyntax) **   <a name="verifiedpermissions-GetIdentitySource-response-createdDate"></a>
The date and time that the identity source was originally created.  
Type: Timestamp

 ** [identitySourceId](#API_GetIdentitySource_ResponseSyntax) **   <a name="verifiedpermissions-GetIdentitySource-response-identitySourceId"></a>
The ID of the identity source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[a-zA-Z0-9-]*` 

 ** [lastUpdatedDate](#API_GetIdentitySource_ResponseSyntax) **   <a name="verifiedpermissions-GetIdentitySource-response-lastUpdatedDate"></a>
The date and time that the identity source was most recently updated.  
Type: Timestamp

 ** [policyStoreId](#API_GetIdentitySource_ResponseSyntax) **   <a name="verifiedpermissions-GetIdentitySource-response-policyStoreId"></a>
The ID of the policy store that contains the identity source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[a-zA-Z0-9-/_]*` 

 ** [principalEntityType](#API_GetIdentitySource_ResponseSyntax) **   <a name="verifiedpermissions-GetIdentitySource-response-principalEntityType"></a>
The data type of principals generated for identities authenticated by this identity source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `.*` 

 ** [configuration](#API_GetIdentitySource_ResponseSyntax) **   <a name="verifiedpermissions-GetIdentitySource-response-configuration"></a>
Contains configuration information about an identity source.  
Type: [ConfigurationDetail](API_ConfigurationDetail.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [details](#API_GetIdentitySource_ResponseSyntax) **   <a name="verifiedpermissions-GetIdentitySource-response-details"></a>
 *This parameter has been deprecated.*   
A structure that describes the configuration of the identity source.  
Type: [IdentitySourceDetails](API_IdentitySourceDetails.md) object

## Errors
<a name="API_GetIdentitySource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed because of an internal error. Try your request again later  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The request failed because it references a resource that doesn't exist.    
 ** resourceId **   
The unique ID of the resource referenced in the failed request.  
 ** resourceType **   
The resource type of the resource referenced in the failed request.
HTTP Status Code: 400

 ** ThrottlingException **   
The request failed because it exceeded a throttling quota.    
 ** quotaCode **   
The quota code recognized by the Amazon Service Quotas service.  
 ** serviceCode **   
The code for the Amazon Web Services service that owns the quota.
HTTP Status Code: 400

 ** ValidationException **   
The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.  
The possible reasons include the following:  
+  **UnrecognizedEntityType** 

  The policy includes an entity type that isn't found in the schema.
+  **UnrecognizedActionId** 

  The policy includes an action id that isn't found in the schema.
+  **InvalidActionApplication** 

  The policy includes an action that, according to the schema, doesn't support the specified principal and resource.
+  **UnexpectedType** 

  The policy included an operand that isn't a valid type for the specified operation.
+  **IncompatibleTypes** 

  The types of elements included in a `set`, or the types of expressions used in an `if...then...else` clause aren't compatible in this context.
+  **MissingAttribute** 

  The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the [has (presence of attribute test) operator](https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test) in the *Cedar Policy Language Guide*.
+  **UnsafeOptionalAttributeAccess** 

  The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the [has (presence of attribute test) operator](https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test) in the *Cedar Policy Language Guide*.
+  **ImpossiblePolicy** 

  Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.
+  **WrongNumberArguments** 

  The policy references an extension type with the wrong number of arguments.
+  **FunctionArgumentValidationError** 

  Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.  
 ** fieldList **   
The list of fields that aren't valid.
HTTP Status Code: 400

## Examples
<a name="API_GetIdentitySource_Examples"></a>

### Example
<a name="API_GetIdentitySource_Example_1"></a>

The following example retrieves the details for the specified identity source.

#### Sample Request
<a name="API_GetIdentitySource_Example_1_Request"></a>

```
POST HTTP/1.1
Host: verifiedpermissions.us-east-1.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: identity
X-Amz-Target: VerifiedPermissions.GetIdentitySource
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>

{
    "identitySourceId": "ISEXAMPLEabcdefg111111",
    "policyStoreId": "PSEXAMPLEabcdefg111111"
}
```

#### Sample Response
<a name="API_GetIdentitySource_Example_1_Response"></a>

```
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
vary: origin
vary: access-control-request-method
vary: access-control-request-headers
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive

{
    "createdDate": "2023-05-19T20:30:28.173926Z",
    "details": {
        "clientIds": [ "a1b2c3d4e5f6g7h8i9j0kalbmc" ],
        "userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5",
        "discoveryUrl":"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5",
        "openIdIssuer":"COGNITO"
    },
    "identitySourceId":"ISEXAMPLEabcdefg111111",
    "lastUpdatedDate":"2023-05-22T20:45:59.962216Z",
    "policyStoreId":"PSEXAMPLEabcdefg111111",
    "principalEntityType":"MyCorp::User",
    "configuration": {
        "cognitoUserPoolConfiguration": {
            "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5",
            "clientIds": [],
            "issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5",
            "groupConfiguration": {
                "groupEntityType": "MyCorp::UserGroup"
            }
        }
    }
}
```

## See Also
<a name="API_GetIdentitySource_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/verifiedpermissions-2021-12-01/GetIdentitySource) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/verifiedpermissions-2021-12-01/GetIdentitySource)