Addresses

Addresses schema from AWS IAM Identity Center

Access ControlAuthenticationIdentity ManagementSingle Sign-On
View JSON Schema on GitHub

JSON Schema

identitystore-addresses-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-identity-center/refs/heads/main/json-schema/identitystore-addresses-schema.json",
  "title": "Addresses",
  "description": "Addresses schema from AWS IAM Identity Center",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "StreetAddress": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveStringType"
          },
          {
            "description": "The street of the address."
          }
        ]
      },
      "Locality": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveStringType"
          },
          {
            "description": "A string of the address locality."
          }
        ]
      },
      "Region": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveStringType"
          },
          {
            "description": "The region of the address."
          }
        ]
      },
      "PostalCode": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveStringType"
          },
          {
            "description": "The postal code of the address."
          }
        ]
      },
      "Country": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveStringType"
          },
          {
            "description": "The country of the address."
          }
        ]
      },
      "Formatted": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveStringType"
          },
          {
            "description": "A string containing a formatted version of the address for display."
          }
        ]
      },
      "Type": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveStringType"
          },
          {
            "description": "A string representing the type of address. For example, \"Home.\""
          }
        ]
      },
      "Primary": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SensitiveBooleanType"
          },
          {
            "description": "A Boolean value representing whether this is the primary address for the associated resource."
          }
        ]
      }
    },
    "description": "The address associated with the specified user."
  }
}