current_users

Creates, updates, deletes, gets or lists a current_users resource.

Overview

Name	current_users
Type	Resource
Id	aws.workdocs.current_users

Fields

The following fields are returned by SELECT queries:

get_current_user

Name	Datatype	Description
created_timestamp	string (date-time)	The time when the user was created.
email_address	string	The email address of the user. (pattern: <code>[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,}</code>)
given_name	string	The given name of the user.
id	string	The ID of the user. (pattern: <code>[&\w+-.@]+</code>)
locale	string	The locale of the user. (en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default)
modified_timestamp	string (date-time)	The time when the user was modified.
organization_id	string	The ID of the organization. (pattern: <code>[&\w+-.@]+</code>)
recycle_bin_folder_id	string	The ID of the recycle bin folder. (pattern: <code>[\w+-.@]+</code>)
root_folder_id	string	The ID of the root folder. (pattern: <code>[\w+-.@]+</code>)
status	string	The status of the user. (ACTIVE, INACTIVE, PENDING)
storage	object	The storage for the user.
surname	string	The surname of the user.
time_zone_id	string	The time zone ID of the user.
type	string	The type of user. (USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER)
username	string	The login name of the user. (pattern: <code>[\w-+.]+(@[a-zA-Z0-9.-]+.[a-zA-Z]+)?</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_current_user	select	Authentication, region		Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
Authentication	string	Amazon WorkDocs authentication token.
region	string	AWS region (default: us-east-1)

SELECT examples

get_current_user

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

SELECT
created_timestamp,
email_address,
given_name,
id,
locale,
modified_timestamp,
organization_id,
recycle_bin_folder_id,
root_folder_id,
status,
storage,
surname,
time_zone_id,
type,
username
FROM aws.workdocs.current_users
WHERE Authentication = '{{ Authentication }}' -- required
AND region = '{{ region }}' -- required
;