ListUsers
GET {{baseUrl}}/users/?compartmentId={{tenancy_ocid}}&limit=693&sortBy=NAME&sortOrder=ASC
Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy's OCID and User's OCID.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment). | |
page | string | The value of the opc-next-page response header from the previous "List" call. | |
limit | number | The maximum number of items to return in a paginated "List" call. | |
identityProviderId | string | The id of the identity provider. | |
externalIdentifier | string | The id of a user in the identity provider. | |
name | string | A filter to only return resources that match the given name exactly. | |
sortBy | string | The field to sort by. You can provide one sort order (sortOrder). Default order for | |
| TIMECREATED is descending. Default order for NAME is ascending. The NAME | |||
| sort order is case sensitive. |
Note: In general, some "List" operations (for example, ListInstances) let you
optionally filter by Availability Domain if the scope of the resource type is within a
single Availability Domain. If you call one of these "List" operations without specifying
an Availability Domain, the resources are grouped by Availability Domain, then sorted.
|
| sortOrder | string | | The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order
is case sensitive.
|
| lifecycleState | string | | A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
|
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"id":"irure aliquip ad voluptate","compartmentId":"sit aliquip ut","name":"reprehenderit exercitation sint anim","description":"proident quis dolore","timeCreated":"1968-09-11T23:28:01.429Z","lifecycleState":"DELETING","isMfaActivated":false,"capabilities":{"canUseApiKeys":false,"canUseAuthTokens":false,"canUseConsolePassword":true,"canUseCustomerSecretKeys":true,"canUseOAuth2ClientCredentials":true,"canUseSmtpCredentials":true},"definedTags":{},"email":"magna culpa","emailVerified":false,"externalIdentifier":"in","freeformTags":{},"identityProviderId":"id Duis est culpa","inactiveStatus":-92279453,"lastSuccessfulLoginTime":"2001-03-27T18:47:52.804Z","previousSuccessfulLoginTime":"1960-10-31T03:31:43.230Z"},{"id":"aute sed","compartmentId":"id quis minim in","name":"est deserunt aute aliqua","description":"quis in sed","timeCreated":"2004-12-02T07:08:16.078Z","lifecycleState":"ACTIVE","isMfaActivated":false,"capabilities":{"canUseApiKeys":false,"canUseAuthTokens":false,"canUseConsolePassword":true,"canUseCustomerSecretKeys":true,"canUseOAuth2ClientCredentials":false,"canUseSmtpCredentials":true},"definedTags":{},"email":"proident cillum mollit commodo","emailVerified":true,"externalIdentifier":"qui","freeformTags":{},"identityProviderId":"ad aute eiusmod irure qui","inactiveStatus":21807873,"lastSuccessfulLoginTime":"2017-02-03T00:56:12.543Z","previousSuccessfulLoginTime":"1980-08-13T07:20:24.511Z"}]