Amazon Cognito · Schema

GetCredentialsForIdentityInput

Input to the GetCredentialsForIdentity action.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
IdentityId object
Logins object
CustomRoleArn object
View JSON Schema on GitHub

JSON Schema

identity-pools-get-credentials-for-identity-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/identity-pools-get-credentials-for-identity-input-schema.json",
  "title": "GetCredentialsForIdentityInput",
  "description": "Input to the <code>GetCredentialsForIdentity</code> action.",
  "type": "object",
  "properties": {
    "IdentityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityId"
        },
        {
          "description": "A unique identifier in the format REGION:GUID."
        }
      ]
    },
    "Logins": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoginsMap"
        },
        {
          "description": "<p>A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax \"provider_name\": \"provider_user_identifier\".</p> <p>Logins should not be specified when trying to get credentials for an unauthenticated identity.</p> <p>The Logins parameter is required when using identities associated with external identity providers such as Facebook. For examples of <code>Logins</code> maps, see the code examples in the <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html\">External Identity Providers</a> section of the Amazon Cognito Developer Guide.</p>"
        }
      ]
    },
    "CustomRoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARNString"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization."
        }
      ]
    }
  },
  "required": [
    "IdentityId"
  ]
}