Amazon Connect · JSON Structure

Create User Request Structure

CreateUserRequest schema from Amazon Connect Service API

Type: object Properties: 9 Required: 4
ChatContact CenterCustomer ServiceVoiceAIOmnichannel

CreateUserRequest is a JSON Structure definition published by Amazon Connect, describing 9 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Username Password IdentityInfo PhoneConfig DirectoryUserId SecurityProfileIds RoutingProfileId HierarchyGroupId Tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-connect/refs/heads/main/json-structure/create-user-request-structure.json",
  "name": "CreateUserRequest",
  "description": "CreateUserRequest schema from Amazon Connect Service API",
  "type": "object",
  "properties": {
    "Username": {
      "type": "string",
      "description": "The user name for the account.",
      "example": "jsmith"
    },
    "Password": {
      "type": "string",
      "description": "The password for the user account."
    },
    "IdentityInfo": {
      "$ref": "#/components/schemas/UserIdentityInfo"
    },
    "PhoneConfig": {
      "$ref": "#/components/schemas/UserPhoneConfig"
    },
    "DirectoryUserId": {
      "type": "string"
    },
    "SecurityProfileIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The identifier of the security profile for the user."
    },
    "RoutingProfileId": {
      "type": "string",
      "description": "The identifier of the routing profile for the user.",
      "example": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE"
    },
    "HierarchyGroupId": {
      "type": "string"
    },
    "Tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": [
    "PhoneConfig",
    "RoutingProfileId",
    "SecurityProfileIds",
    "Username"
  ]
}