[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Users In Organization By Organization ID And User Search Term

Description

Search 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 Owner ✔️ ✔️

Request

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users/search
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Query Parameters

Query Parameters

string
expandProfile Optional

Indicates if the response should be expanded with the user profile, the value is ignored, only the existence of parameter is checked.

Parameter Serialization Style: form Explode:true

string
includeGroupIdsInRoles Optional

Indicates if the inherited roles in the response should indicate group information, the value is ignored, only the existence of parameter is checked.

Parameter Serialization Style: form Explode:true

string
userSearchTerm Required

The string to be searched within email or firstName or lastName or username

Parameter Serialization Style: form Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns SearchUsersResponse of type application/json
{
	"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"
			}
		}
	]
}
results Optional

List of users that are found.

Errors

Errors

400

userSearchTerm query parameter must be specified


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found.


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users/search?userSearchTerm=string
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_member,org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?