Get Users In Organization By Organization ID And User Search Term Deprecated
DescriptionSearch users in organization having username, firstName, lastName or email which “contains” search term.
e.g. search for “test” will return test@vmware.com if test@vmware.com is part of the organization.
Search results limited to first 20 results. Please refine the search term for accurate results.
Organization members will receive basic user information. Organization owners and Service Owners (for organizations that have access to the service) will additionally receive role details of the users.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Query Parameters
Query Parameters
Indicates if the response should be expanded with the user profile, the value is ignored, only the existence of parameter is checked.
Indicates if the inherited roles in the response should indicate group information, the value is ignored, only the existence of parameter is checked.
The string to be searched within email or firstName or lastName or username.
Authentication
Response
Response BodyResponse Body
200 OK
{
"results": [
{
"customRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"orgId": "string",
"organizationRoles": [
{
"createdBy": "string",
"createdDate": "string",
"displayName": "string",
"expiresAt": 3609941597,
"groupIds": [
"string"
],
"groups": [
{
"description": "string",
"displayName": "string",
"domain": "string",
"groupType": "USER_GROUP",
"id": "string",
"ownerOrgId": "string",
"sharedOrgIds": [
"string"
],
"usersCount": 0
}
],
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoleNames": [
"string"
],
"serviceRoles": [
{
"createdBy": "string",
"createdDate": "string",
"expiresAt": 3609941597,
"groupIds": [
"string"
],
"groups": [
{
"description": "string",
"displayName": "string",
"domain": "string",
"groupType": "USER_GROUP",
"id": "string",
"ownerOrgId": "string",
"sharedOrgIds": [
"string"
],
"usersCount": 0
}
],
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
]
}
],
"user": {
"accessible": false,
"acct": "string",
"domain": "string",
"email": "string",
"firstName": "string",
"idpId": "string",
"lastName": "string",
"userId": "string",
"userProfile": {
"alternativeEmail": "string",
"language": "string",
"locale": "string"
},
"username": "string"
}
}
]
}
Errors
userSearchTerm query parameter must be specified
The user is not authorized to use the API
The user is forbidden to use the API
Organization with this identifier is not found.
The user has sent too many requests
An unexpected error has occurred while processing the request
Code Samples
cURL Command
Vendor Extensions
x-required-roles: org_member,org_admin,org_owner
x-slo-tier: TIER2
x-vmw-doc-deprecated: ""
