CmdID / aws / aws workdocs

aws workdocs describe-users

Describes the specified users. AWS CLI reference

1 example 10 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To retrieve details for specified users

The following describe-users example retrieves details for all the users in the specified organization.

aws workdocs describe-users --organization-id d-926726012cIdentify

--organization-idThe ID of the organization.

Its output

{
    "Users": [
        {
            "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
            "Username": "example1User",
            "OrganizationId": "d-926726012c",
            "RootFolderId": "3c0e3f849dd20a9771d937b9bbcc97e18796150ae56c26d64a4fa0320a2dedc9",
            "RecycleBinFolderId": "c277f4c4d647be1f5147b3184ffa96e1e2bf708278b696cacba68ba13b91f4fe",
            "Status": "INACTIVE",
            "Type": "USER",
            "CreatedTimestamp": 1535478999.452,
            "ModifiedTimestamp": 1535478999.452
        },
        {
            "Id": "S-1-1-11-1111111111-2222222222-3333333333-4444&d-926726012c",
            "Username": "example2User",
            "EmailAddress": "example2User@site.awsapps.com",
            "GivenName": "example2Name",
            "Surname": "example2Surname",
            "OrganizationId": "d-926726012c",
            "RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390",
            "RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff",
            "Status": "ACTIVE",
            "Type": "MINIMALUSER",
            "CreatedTimestamp": 1535478836.584,
            "ModifiedTimestamp": 1535478836.584
        }
    ]
}

Options

10 in the AWS CLI reference

--authentication-tokenAmazon WorkDocs authentication token.

--fieldsA comma-separated list of values.

--includeThe state of the users.

--limitThe maximum number of items to return.

--markerThe marker for the next set of results.

--orderThe order for the results.

--organization-idThe ID of the organization.

--sortThe sorting criteria.

--user-idsThe IDs of the users.

--user-queryA query to filter users by user name.