describeUser method

Future<DescribeUserResponse> describeUser({ required String organizationId, required String userId, })

Provides information regarding the user.

May throw DirectoryServiceAuthenticationFailedException. May throw DirectoryUnavailableException. May throw EntityNotFoundException. May throw InvalidParameterException. May throw OrganizationNotFoundException. May throw OrganizationStateException.

Parameter organizationId : The identifier for the organization under which the user exists.

Parameter userId : The identifier for the user to be described.

The identifier can be the UserId, Username, or email. The following identity formats are available:

• User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
• Email address: [e-mail]
• User name: user

Implementation

Future<DescribeUserResponse> describeUser({
  required String organizationId,
  required String userId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'WorkMailService.DescribeUser'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'OrganizationId': organizationId,
      'UserId': userId,
    },
  );

  return DescribeUserResponse.fromJson(jsonResponse.body);
}