AddGroupMember

$result = $client->addGroupMember([/* ... */]);
$promise = $client->addGroupMemberAsync([/* ... */]);

Adds an existing user, group, or computer as a group member.

Parameter Syntax

$result = $client->addGroupMember([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'GroupName' => '<string>', // REQUIRED
    'MemberName' => '<string>', // REQUIRED
    'MemberRealm' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Creates a new group.

Parameter Syntax

$result = $client->createGroup([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'GroupScope' => 'DomainLocal|Global|Universal|BuiltinLocal',
    'GroupType' => 'Distribution|Security',
    'OtherAttributes' => [
        '<LdapDisplayName>' => [
            'BOOL' => true || false,
            'N' => <integer>,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'SAMAccountName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'SAMAccountName' => '<string>',
    'SID' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

CreateUser

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

Creates a new user.

Parameter Syntax

$result = $client->createUser([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'EmailAddress' => '<string>',
    'GivenName' => '<string>',
    'OtherAttributes' => [
        '<LdapDisplayName>' => [
            'BOOL' => true || false,
            'N' => <integer>,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'SAMAccountName' => '<string>', // REQUIRED
    'Surname' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'SAMAccountName' => '<string>',
    'SID' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

DeleteGroup

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

Deletes a group.

Parameter Syntax

$result = $client->deleteGroup([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'SAMAccountName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

DeleteUser

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

Deletes a user.

Parameter Syntax

$result = $client->deleteUser([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'SAMAccountName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

DescribeGroup

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

Returns information about a specific group.

Parameter Syntax

$result = $client->describeGroup([
    'DirectoryId' => '<string>', // REQUIRED
    'OtherAttributes' => ['<string>', ...],
    'Realm' => '<string>',
    'SAMAccountName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'DistinguishedName' => '<string>',
    'GroupScope' => 'DomainLocal|Global|Universal|BuiltinLocal',
    'GroupType' => 'Distribution|Security',
    'OtherAttributes' => [
        '<LdapDisplayName>' => [
            'BOOL' => true || false,
            'N' => <integer>,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'Realm' => '<string>',
    'SAMAccountName' => '<string>',
    'SID' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

DescribeUser

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

Returns information about a specific user.

Parameter Syntax

$result = $client->describeUser([
    'DirectoryId' => '<string>', // REQUIRED
    'OtherAttributes' => ['<string>', ...],
    'Realm' => '<string>',
    'SAMAccountName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'DistinguishedName' => '<string>',
    'EmailAddress' => '<string>',
    'Enabled' => true || false,
    'GivenName' => '<string>',
    'OtherAttributes' => [
        '<LdapDisplayName>' => [
            'BOOL' => true || false,
            'N' => <integer>,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'Realm' => '<string>',
    'SAMAccountName' => '<string>',
    'SID' => '<string>',
    'Surname' => '<string>',
    'UserPrincipalName' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

DisableUser

$result = $client->disableUser([/* ... */]);
$promise = $client->disableUserAsync([/* ... */]);

Deactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.

Parameter Syntax

$result = $client->disableUser([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'SAMAccountName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

ListGroupMembers

$result = $client->listGroupMembers([/* ... */]);
$promise = $client->listGroupMembersAsync([/* ... */]);

Returns member information for the specified group.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupMembers.NextToken member contains a token that you pass in the next call to ListGroupMembers. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

Parameter Syntax

$result = $client->listGroupMembers([
    'DirectoryId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MemberRealm' => '<string>',
    'NextToken' => '<string>',
    'Realm' => '<string>',
    'SAMAccountName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'MemberRealm' => '<string>',
    'Members' => [
        [
            'MemberType' => 'USER|GROUP|COMPUTER',
            'SAMAccountName' => '<string>',
            'SID' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Realm' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

ListGroups

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

Returns group information for the specified directory.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroups.NextToken member contains a token that you pass in the next call to ListGroups. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

Parameter Syntax

$result = $client->listGroups([
    'DirectoryId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Realm' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'Groups' => [
        [
            'GroupScope' => 'DomainLocal|Global|Universal|BuiltinLocal',
            'GroupType' => 'Distribution|Security',
            'SAMAccountName' => '<string>',
            'SID' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Realm' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

ListGroupsForMember

$result = $client->listGroupsForMember([/* ... */]);
$promise = $client->listGroupsForMemberAsync([/* ... */]);

Returns group information for the specified member.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupsForMember.NextToken member contains a token that you pass in the next call to ListGroupsForMember. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

Parameter Syntax

$result = $client->listGroupsForMember([
    'DirectoryId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MemberRealm' => '<string>',
    'NextToken' => '<string>',
    'Realm' => '<string>',
    'SAMAccountName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'Groups' => [
        [
            'GroupScope' => 'DomainLocal|Global|Universal|BuiltinLocal',
            'GroupType' => 'Distribution|Security',
            'SAMAccountName' => '<string>',
            'SID' => '<string>',
        ],
        // ...
    ],
    'MemberRealm' => '<string>',
    'NextToken' => '<string>',
    'Realm' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

ListUsers

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

Returns user information for the specified directory.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListUsers.NextToken member contains a token that you pass in the next call to ListUsers. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

Parameter Syntax

$result = $client->listUsers([
    'DirectoryId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Realm' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'NextToken' => '<string>',
    'Realm' => '<string>',
    'Users' => [
        [
            'Enabled' => true || false,
            'GivenName' => '<string>',
            'SAMAccountName' => '<string>',
            'SID' => '<string>',
            'Surname' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

RemoveGroupMember

$result = $client->removeGroupMember([/* ... */]);
$promise = $client->removeGroupMemberAsync([/* ... */]);

Removes a member from a group.

Parameter Syntax

$result = $client->removeGroupMember([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'GroupName' => '<string>', // REQUIRED
    'MemberName' => '<string>', // REQUIRED
    'MemberRealm' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

SearchGroups

$result = $client->searchGroups([/* ... */]);
$promise = $client->searchGroupsAsync([/* ... */]);

Searches the specified directory for a group. You can find groups that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the SearchGroups.NextToken member contains a token that you pass in the next call to SearchGroups. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

Parameter Syntax

$result = $client->searchGroups([
    'DirectoryId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Realm' => '<string>',
    'SearchAttributes' => ['<string>', ...], // REQUIRED
    'SearchString' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'Groups' => [
        [
            'DistinguishedName' => '<string>',
            'GroupScope' => 'DomainLocal|Global|Universal|BuiltinLocal',
            'GroupType' => 'Distribution|Security',
            'OtherAttributes' => [
                '<LdapDisplayName>' => [
                    'BOOL' => true || false,
                    'N' => <integer>,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'SAMAccountName' => '<string>',
            'SID' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Realm' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

SearchUsers

$result = $client->searchUsers([/* ... */]);
$promise = $client->searchUsersAsync([/* ... */]);

Searches the specified directory for a user. You can find users that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the SearchUsers.NextToken member contains a token that you pass in the next call to SearchUsers. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

Parameter Syntax

$result = $client->searchUsers([
    'DirectoryId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Realm' => '<string>',
    'SearchAttributes' => ['<string>', ...], // REQUIRED
    'SearchString' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'NextToken' => '<string>',
    'Realm' => '<string>',
    'Users' => [
        [
            'DistinguishedName' => '<string>',
            'EmailAddress' => '<string>',
            'Enabled' => true || false,
            'GivenName' => '<string>',
            'OtherAttributes' => [
                '<LdapDisplayName>' => [
                    'BOOL' => true || false,
                    'N' => <integer>,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'SAMAccountName' => '<string>',
            'SID' => '<string>',
            'Surname' => '<string>',
            'UserPrincipalName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

UpdateGroup

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

Updates group information.

Parameter Syntax

$result = $client->updateGroup([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'GroupScope' => 'DomainLocal|Global|Universal|BuiltinLocal',
    'GroupType' => 'Distribution|Security',
    'OtherAttributes' => [
        '<LdapDisplayName>' => [
            'BOOL' => true || false,
            'N' => <integer>,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'SAMAccountName' => '<string>', // REQUIRED
    'UpdateType' => 'ADD|REPLACE|REMOVE',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.

UpdateUser

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

Updates user information.

Parameter Syntax

$result = $client->updateUser([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>', // REQUIRED
    'EmailAddress' => '<string>',
    'GivenName' => '<string>',
    'OtherAttributes' => [
        '<LdapDisplayName>' => [
            'BOOL' => true || false,
            'N' => <integer>,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'SAMAccountName' => '<string>', // REQUIRED
    'Surname' => '<string>',
    'UpdateType' => 'ADD|REPLACE|REMOVE',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

AccessDeniedException:

You don't have permission to perform the request or access the directory. It can also occur when the DirectoryId doesn't exist or the user, member, or group might be outside of your organizational unit (OU).

Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.

InternalServerException:

The operation didn't succeed because an internal error occurred. Try again later.

ValidationException:

The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.

DirectoryUnavailableException:

The request could not be completed due to a problem in the configuration or current state of the specified directory.

ConflictException:

This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.

This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.

ThrottlingException:

The limit on the number of requests per second has been exceeded.