SDK for PHP V3

Indicates that a requested resource is not found.

Indicates that the principal has crossed the throttling limits of the API operations.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

The request failed because it contains a syntax error.

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

CreateGroupMembership

$result = $client->createGroupMembership([/* ... */]);
$promise = $client->createGroupMembershipAsync([/* ... */]);

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

Parameter Syntax

$result = $client->createGroupMembership([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'MemberId' => [ // REQUIRED
        'UserId' => '<string>',
    ],
]);

Parameter Details

Members

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MemberId

: Required: Yes
: Type: MemberId structure

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'MembershipId' => '<string>',
]

Result Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MembershipId

: Required: Yes
: Type: string

The identifier for a newly created GroupMembership in an identity store.

Errors

Indicates that a requested resource is not found.

Indicates that the principal has crossed the throttling limits of the API operations.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

The request failed because it contains a syntax error.

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a user within the specified identity store.

Parameter Syntax

$result = $client->createUser([
    'Addresses' => [
        [
            'Country' => '<string>',
            'Formatted' => '<string>',
            'Locality' => '<string>',
            'PostalCode' => '<string>',
            'Primary' => true || false,
            'Region' => '<string>',
            'StreetAddress' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'Birthdate' => '<string>',
    'DisplayName' => '<string>',
    'Emails' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
    'Locale' => '<string>',
    'Name' => [
        'FamilyName' => '<string>',
        'Formatted' => '<string>',
        'GivenName' => '<string>',
        'HonorificPrefix' => '<string>',
        'HonorificSuffix' => '<string>',
        'MiddleName' => '<string>',
    ],
    'NickName' => '<string>',
    'PhoneNumbers' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Photos' => [
        [
            'Display' => '<string>',
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'PreferredLanguage' => '<string>',
    'ProfileUrl' => '<string>',
    'Timezone' => '<string>',
    'Title' => '<string>',
    'UserName' => '<string>',
    'UserType' => '<string>',
    'Website' => '<string>',
]);

Parameter Details

Members

Addresses

: Type: Array of Address structures

A list of Address objects containing addresses associated with the user.

Birthdate

: Type: string

The user's birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.

DisplayName

: Type: string

A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe." When used in IAM Identity Center, this parameter is required.

Emails

: Type: Array of Email structures

A list of Email objects containing email addresses associated with the user.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

Locale

: Type: string

A string containing the geographical region or location of the user.

Name

: Type: Name structure

An object containing the name of the user. When used in IAM Identity Center, this parameter is required.

NickName

: Type: string

A string containing an alternate name for the user.

PhoneNumbers

: Type: Array of PhoneNumber structures

A list of PhoneNumber objects containing phone numbers associated with the user.

Photos

: Type: Array of Photo structures

A list of photos associated with the user. You can add up to 3 photos per user. Each photo can include a value, type, display name, and primary designation.

PreferredLanguage

: Type: string

A string containing the preferred language of the user. For example, "American English" or "en-us."

ProfileUrl

: Type: string

A string containing a URL that might be associated with the user.

Timezone

: Type: string

A string containing the time zone of the user.

Title

: Type: string

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

UserName

: Type: string

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

UserType

: Type: string

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

Website

: Type: string

The user's personal website or blog URL. This field allows users to provide a link to their personal or professional website.

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'UserId' => '<string>',
]

Result Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

UserId

: Required: Yes
: Type: string

The identifier of the newly created user in the identity store.

Errors

Indicates that a requested resource is not found.

Indicates that the principal has crossed the throttling limits of the API operations.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

The request failed because it contains a syntax error.

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Delete a group within an identity store given GroupId.

Parameter Syntax

$result = $client->deleteGroup([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Indicates that a requested resource is not found.

Indicates that the principal has crossed the throttling limits of the API operations.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

The request failed because it contains a syntax error.

DeleteGroupMembership

$result = $client->deleteGroupMembership([/* ... */]);
$promise = $client->deleteGroupMembershipAsync([/* ... */]);

Delete a membership within a group given MembershipId.

Parameter Syntax

$result = $client->deleteGroupMembership([
    'IdentityStoreId' => '<string>', // REQUIRED
    'MembershipId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MembershipId

: Required: Yes
: Type: string

The identifier for a GroupMembership in an identity store.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Indicates that a requested resource is not found.

Indicates that the principal has crossed the throttling limits of the API operations.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

The request failed because it contains a syntax error.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes a user within an identity store given UserId.

Parameter Syntax

$result = $client->deleteUser([
    'IdentityStoreId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

UserId

: Required: Yes
: Type: string

The identifier for a user in the identity store.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Indicates that a requested resource is not found.

Indicates that the principal has crossed the throttling limits of the API operations.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

The request failed because it contains a syntax error.

DescribeGroup

$result = $client->describeGroup([/* ... */]);
$promise = $client->describeGroupAsync([/* ... */]);

Retrieves the group metadata and attributes from GroupId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameter Syntax

$result = $client->describeGroup([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'CreatedBy' => '<string>',
    'Description' => '<string>',
    'DisplayName' => '<string>',
    'ExternalIds' => [
        [
            'Id' => '<string>',
            'Issuer' => '<string>',
        ],
        // ...
    ],
    'GroupId' => '<string>',
    'IdentityStoreId' => '<string>',
    'UpdatedAt' => <DateTime>,
    'UpdatedBy' => '<string>',
]

Result Details

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the group was created.

CreatedBy

: Type: string

The identifier of the user or system that created the group.

Description

: Type: string

A string containing a description of the group.

DisplayName

: Type: string

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.

ExternalIds

: Type: Array of ExternalId structures

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the group was last updated.

UpdatedBy

: Type: string

The identifier of the user or system that last updated the group.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

DescribeGroupMembership

$result = $client->describeGroupMembership([/* ... */]);
$promise = $client->describeGroupMembershipAsync([/* ... */]);

Retrieves membership metadata and attributes from MembershipId in an identity store.

Parameter Syntax

$result = $client->describeGroupMembership([
    'IdentityStoreId' => '<string>', // REQUIRED
    'MembershipId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MembershipId

: Required: Yes
: Type: string

The identifier for a GroupMembership in an identity store.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'CreatedBy' => '<string>',
    'GroupId' => '<string>',
    'IdentityStoreId' => '<string>',
    'MemberId' => [
        'UserId' => '<string>',
    ],
    'MembershipId' => '<string>',
    'UpdatedAt' => <DateTime>,
    'UpdatedBy' => '<string>',
]

Result Details

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the group membership was created.

CreatedBy

: Type: string

The identifier of the user or system that created the group membership.

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MemberId

: Required: Yes
: Type: MemberId structure

An object containing the identifier of a group member.

MembershipId

: Required: Yes
: Type: string

The identifier for a GroupMembership in an identity store.

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the group membership was last updated.

UpdatedBy

: Type: string

The identifier of the user or system that last updated the group membership.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

Retrieves the user metadata and attributes from the UserId in an identity store.

Parameter Syntax

$result = $client->describeUser([
    'IdentityStoreId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IdentityStoreId

: Required: Yes
: Type: string

UserId

: Required: Yes
: Type: string

The identifier for a user in the identity store.

Result Syntax

[
    'Addresses' => [
        [
            'Country' => '<string>',
            'Formatted' => '<string>',
            'Locality' => '<string>',
            'PostalCode' => '<string>',
            'Primary' => true || false,
            'Region' => '<string>',
            'StreetAddress' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'Birthdate' => '<string>',
    'CreatedAt' => <DateTime>,
    'CreatedBy' => '<string>',
    'DisplayName' => '<string>',
    'Emails' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ExternalIds' => [
        [
            'Id' => '<string>',
            'Issuer' => '<string>',
        ],
        // ...
    ],
    'IdentityStoreId' => '<string>',
    'Locale' => '<string>',
    'Name' => [
        'FamilyName' => '<string>',
        'Formatted' => '<string>',
        'GivenName' => '<string>',
        'HonorificPrefix' => '<string>',
        'HonorificSuffix' => '<string>',
        'MiddleName' => '<string>',
    ],
    'NickName' => '<string>',
    'PhoneNumbers' => [
        [
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Photos' => [
        [
            'Display' => '<string>',
            'Primary' => true || false,
            'Type' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'PreferredLanguage' => '<string>',
    'ProfileUrl' => '<string>',
    'Timezone' => '<string>',
    'Title' => '<string>',
    'UpdatedAt' => <DateTime>,
    'UpdatedBy' => '<string>',
    'UserId' => '<string>',
    'UserName' => '<string>',
    'UserStatus' => 'ENABLED|DISABLED',
    'UserType' => '<string>',
    'Website' => '<string>',
]

Result Details

Members

Addresses

: Type: Array of Address structures

The physical address of the user.

Birthdate

: Type: string

The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the user was created.

CreatedBy

: Type: string

The identifier of the user or system that created the user.

DisplayName

: Type: string

The display name of the user.

Emails

: Type: Array of Email structures

The email address of the user.

ExternalIds

: Type: Array of ExternalId structures

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

Locale

: Type: string

A string containing the geographical region or location of the user.

Name

: Type: Name structure

The name of the user.

NickName

: Type: string

An alternative descriptive name for the user.

PhoneNumbers

: Type: Array of PhoneNumber structures

A list of PhoneNumber objects associated with a user.

Photos

: Type: Array of Photo structures

A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.

PreferredLanguage

: Type: string

The preferred language of the user.

ProfileUrl

: Type: string

A URL link for the user's profile.

Timezone

: Type: string

The time zone for a user.

Title

: Type: string

A string containing the title of the user.

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the user was last updated.

UpdatedBy

: Type: string

The identifier of the user or system that last updated the user.

UserId

: Required: Yes
: Type: string

The identifier for a user in the identity store.

UserName

: Type: string

UserStatus

: Type: string

The current status of the user account.

UserType

: Type: string

A string indicating the type of user.

Website

: Type: string

The user's personal website or blog URL. Returns the stored website information for the user.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

GetGroupId

$result = $client->getGroupId([/* ... */]);
$promise = $client->getGroupIdAsync([/* ... */]);

Retrieves GroupId in an identity store.

Parameter Syntax

$result = $client->getGroupId([
    'AlternateIdentifier' => [ // REQUIRED
        'ExternalId' => [
            'Id' => '<string>', // REQUIRED
            'Issuer' => '<string>', // REQUIRED
        ],
        'UniqueAttribute' => [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => [ // REQUIRED
            ],
        ],
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AlternateIdentifier

: Required: Yes
: Type: AlternateIdentifier structure

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is displayName.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

Result Syntax

[
    'GroupId' => '<string>',
    'IdentityStoreId' => '<string>',
]

Result Details

Members

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

GetGroupMembershipId

$result = $client->getGroupMembershipId([/* ... */]);
$promise = $client->getGroupMembershipIdAsync([/* ... */]);

Retrieves the MembershipId in an identity store.

Parameter Syntax

$result = $client->getGroupMembershipId([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'MemberId' => [ // REQUIRED
        'UserId' => '<string>',
    ],
]);

Parameter Details

Members

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MemberId

: Required: Yes
: Type: MemberId structure

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'MembershipId' => '<string>',
]

Result Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MembershipId

: Required: Yes
: Type: string

The identifier for a GroupMembership in an identity store.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

GetUserId

$result = $client->getUserId([/* ... */]);
$promise = $client->getUserIdAsync([/* ... */]);

Retrieves the UserId in an identity store.

Parameter Syntax

$result = $client->getUserId([
    'AlternateIdentifier' => [ // REQUIRED
        'ExternalId' => [
            'Id' => '<string>', // REQUIRED
            'Issuer' => '<string>', // REQUIRED
        ],
        'UniqueAttribute' => [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => [ // REQUIRED
            ],
        ],
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AlternateIdentifier

: Required: Yes
: Type: AlternateIdentifier structure

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

Result Syntax

[
    'IdentityStoreId' => '<string>',
    'UserId' => '<string>',
]

Result Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

UserId

: Required: Yes
: Type: string

The identifier for a user in the identity store.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

IsMemberInGroups

$result = $client->isMemberInGroups([/* ... */]);
$promise = $client->isMemberInGroupsAsync([/* ... */]);

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

Parameter Syntax

$result = $client->isMemberInGroups([
    'GroupIds' => ['<string>', ...], // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'MemberId' => [ // REQUIRED
        'UserId' => '<string>',
    ],
]);

Parameter Details

Members

GroupIds

: Required: Yes
: Type: Array of strings

A list of identifiers for groups in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MemberId

: Required: Yes
: Type: MemberId structure

An object containing the identifier of a group member.

Result Syntax

[
    'Results' => [
        [
            'GroupId' => '<string>',
            'MemberId' => [
                'UserId' => '<string>',
            ],
            'MembershipExists' => true || false,
        ],
        // ...
    ],
]

Result Details

Members

Results

: Required: Yes
: Type: Array of GroupMembershipExistenceResult structures

A list containing the results of membership existence checks.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

ListGroupMemberships

$result = $client->listGroupMemberships([/* ... */]);
$promise = $client->listGroupMembershipsAsync([/* ... */]);

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

Parameter Syntax

$result = $client->listGroupMemberships([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MaxResults

: Type: int

The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

NextToken

: Type: string

The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Result Syntax

[
    'GroupMemberships' => [
        [
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'GroupId' => '<string>',
            'IdentityStoreId' => '<string>',
            'MemberId' => [
                'UserId' => '<string>',
            ],
            'MembershipId' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedBy' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

GroupMemberships

: Required: Yes
: Type: Array of GroupMembership structures

A list of GroupMembership objects in the group.

NextToken

: Type: string

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

ListGroupMembershipsForMember

$result = $client->listGroupMembershipsForMember([/* ... */]);
$promise = $client->listGroupMembershipsForMemberAsync([/* ... */]);

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

Parameter Syntax

$result = $client->listGroupMembershipsForMember([
    'IdentityStoreId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MemberId' => [ // REQUIRED
        'UserId' => '<string>',
    ],
    'NextToken' => '<string>',
]);

Parameter Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

MaxResults

: Type: int

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

MemberId

: Required: Yes
: Type: MemberId structure

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

NextToken

: Type: string

Result Syntax

[
    'GroupMemberships' => [
        [
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'GroupId' => '<string>',
            'IdentityStoreId' => '<string>',
            'MemberId' => [
                'UserId' => '<string>',
            ],
            'MembershipId' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedBy' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

GroupMemberships

: Required: Yes
: Type: Array of GroupMembership structures

A list of GroupMembership objects in the group for a specified member.

NextToken

: Type: string

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

ListGroups

$result = $client->listGroups([/* ... */]);
$promise = $client->listGroupsAsync([/* ... */]);

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

Parameter Syntax

$result = $client->listGroups([
    'Filters' => [
        [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

IdentityStoreId

: Required: Yes
: Type: string

MaxResults

: Type: int

NextToken

: Type: string

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Result Syntax

[
    'Groups' => [
        [
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'Description' => '<string>',
            'DisplayName' => '<string>',
            'ExternalIds' => [
                [
                    'Id' => '<string>',
                    'Issuer' => '<string>',
                ],
                // ...
            ],
            'GroupId' => '<string>',
            'IdentityStoreId' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedBy' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Groups

: Required: Yes
: Type: Array of Group structures

A list of Group objects in the identity store.

NextToken

: Type: string

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

Parameter Syntax

$result = $client->listUsers([
    'Filters' => [
        [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'IdentityStoreId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

: Type: Array of Filter structures

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

IdentityStoreId

: Required: Yes
: Type: string

MaxResults

: Type: int

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Users' => [
        [
            'Addresses' => [
                [
                    'Country' => '<string>',
                    'Formatted' => '<string>',
                    'Locality' => '<string>',
                    'PostalCode' => '<string>',
                    'Primary' => true || false,
                    'Region' => '<string>',
                    'StreetAddress' => '<string>',
                    'Type' => '<string>',
                ],
                // ...
            ],
            'Birthdate' => '<string>',
            'CreatedAt' => <DateTime>,
            'CreatedBy' => '<string>',
            'DisplayName' => '<string>',
            'Emails' => [
                [
                    'Primary' => true || false,
                    'Type' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'ExternalIds' => [
                [
                    'Id' => '<string>',
                    'Issuer' => '<string>',
                ],
                // ...
            ],
            'IdentityStoreId' => '<string>',
            'Locale' => '<string>',
            'Name' => [
                'FamilyName' => '<string>',
                'Formatted' => '<string>',
                'GivenName' => '<string>',
                'HonorificPrefix' => '<string>',
                'HonorificSuffix' => '<string>',
                'MiddleName' => '<string>',
            ],
            'NickName' => '<string>',
            'PhoneNumbers' => [
                [
                    'Primary' => true || false,
                    'Type' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Photos' => [
                [
                    'Display' => '<string>',
                    'Primary' => true || false,
                    'Type' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'PreferredLanguage' => '<string>',
            'ProfileUrl' => '<string>',
            'Timezone' => '<string>',
            'Title' => '<string>',
            'UpdatedAt' => <DateTime>,
            'UpdatedBy' => '<string>',
            'UserId' => '<string>',
            'UserName' => '<string>',
            'UserStatus' => 'ENABLED|DISABLED',
            'UserType' => '<string>',
            'Website' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

Users

: Required: Yes
: Type: Array of User structures

A list of User objects in the identity store.

Errors

ResourceNotFoundException:: Indicates that a requested resource is not found.
ThrottlingException:: Indicates that the principal has crossed the throttling limits of the API operations.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure with an internal server.
ValidationException:: The request failed because it contains a syntax error.

UpdateGroup

$result = $client->updateGroup([/* ... */]);
$promise = $client->updateGroupAsync([/* ... */]);

Updates the specified group metadata and attributes in the specified identity store.

Parameter Syntax

$result = $client->updateGroup([
    'GroupId' => '<string>', // REQUIRED
    'IdentityStoreId' => '<string>', // REQUIRED
    'Operations' => [ // REQUIRED
        [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => [
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

GroupId

: Required: Yes
: Type: string

The identifier for a group in the identity store.

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

Operations

: Required: Yes
: Type: Array of AttributeOperation structures

A list of AttributeOperation objects to apply to the requested group. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see Group.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Indicates that a requested resource is not found.

Indicates that the principal has crossed the throttling limits of the API operations.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

The request failed because it contains a syntax error.

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

UpdateUser

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);

Updates the specified user metadata and attributes in the specified identity store.

Parameter Syntax

$result = $client->updateUser([
    'IdentityStoreId' => '<string>', // REQUIRED
    'Operations' => [ // REQUIRED
        [
            'AttributePath' => '<string>', // REQUIRED
            'AttributeValue' => [
            ],
        ],
        // ...
    ],
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IdentityStoreId

: Required: Yes
: Type: string

The globally unique identifier for the identity store.

Operations

: Required: Yes
: Type: Array of AttributeOperation structures

A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see User.

UserId

: Required: Yes
: Type: string

The identifier for a user in the identity store.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

Indicates that a requested resource is not found.

Indicates that the principal has crossed the throttling limits of the API operations.

You do not have sufficient access to perform this action.

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

The request processing has failed because of an unknown error, exception or failure with an internal server.

The request failed because it contains a syntax error.