| Column Name | Column Data Type |
|---|
authentication_token Input Column
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. | VARCHAR |
fields Input Column
A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information. | VARCHAR |
include Input Column
The state of the users. Specify "ALL" to include inactive users. | VARCHAR |
order Input Column
The order for the results. | VARCHAR |
organization_id Input Column
The ID of the organization. | VARCHAR |
query Input Column
A query to filter users by user name. Remember the following about the Userids and Query parameters: -
If you don't use either parameter, the API returns a paginated list of all users on the site. -
If you use both parameters, the API ignores the Query parameter. -
The Userid parameter only returns user names that match a corresponding user ID. -
The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson. | VARCHAR |
sort Input Column
The sorting criteria. | VARCHAR |
user_ids Input Column
The IDs of the users. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
total_number_of_users
The total number of users included in the results. | BIGINT |
users
The users. | STRUCT(
"id" VARCHAR,
"username" VARCHAR,
"email_address" VARCHAR,
"given_name" VARCHAR,
"surname" VARCHAR,
"organization_id" VARCHAR,
"root_folder_id" VARCHAR,
"recycle_bin_folder_id" VARCHAR,
"status" VARCHAR,
"type" VARCHAR,
"created_timestamp" TIMESTAMP_S,
"modified_timestamp" TIMESTAMP_S,
"time_zone_id" VARCHAR,
"locale" VARCHAR,
"storage" STRUCT(
"storage_utilized_in_bytes" BIGINT,
"storage_rule" STRUCT(
"storage_allocated_in_bytes" BIGINT,
"storage_type" VARCHAR
)
)
)[] |
Show child fields- users[]
Show child fields- users[].created_timestamp
The time when the user was created. - users[].email_address
The email address of the user. - users[].given_name
The given name of the user. - users[].id
The ID of the user. - users[].locale
The locale of the user. - users[].modified_timestamp
The time when the user was modified. - users[].organization_id
The ID of the organization. - users[].recycle_bin_folder_id
The ID of the recycle bin folder. - users[].root_folder_id
The ID of the root folder. - users[].status
The status of the user. - users[].storage
The storage for the user. Show child fields- users[].storage.storage_rule
The storage for a user. Show child fields- users[].storage.storage_rule.storage_allocated_in_bytes
The amount of storage allocated, in bytes. - users[].storage.storage_rule.storage_type
The type of storage.
- users[].storage.storage_utilized_in_bytes
The amount of storage used, in bytes.
- users[].surname
The surname of the user. - users[].time_zone_id
The time zone ID of the user. - users[].type
The type of user. - users[].username
The login name of the user.
|