[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Get Org Users

Description

Lists all users in an organization with information about their user accounts and roles.

Request

Request

URL

URL


get
https://{api_host}/v1/orgs/{orgId}/users
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


Query Parameters

Query Parameters

string
context Optional

context can be OPERATOR, PROVIDER or TENANT


string
roleId Optional

Unique identifier of the role.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns array of UserOrgAndServiceRolesForAuth of type application/json
{
	"orgRoles": {
		"orgRoles": [
			{
				"displayName": "string",
				"id": "string",
				"memberType": "DIRECT",
				"name": "string",
				"orgId": "string"
			}
		]
	},
	"serviceRolesList": [
		{
			"resourceTypes": [
				"string"
			],
			"resources": [
				{
					"id": "string",
					"name": "string"
				}
			],
			"roles": [
				{
					"associatedResources": [
						"string"
					],
					"defaultRole": false,
					"displayName": "string",
					"enabled": false,
					"hidden": false,
					"memberType": "DIRECT",
					"mspDefaultRole": false,
					"mspDefaultRoleOfProviderAtTenant": false,
					"name": "string",
					"resource": "string",
					"roleId": "string",
					"status": "string"
				}
			],
			"serviceDisplayName": "string",
			"serviceId": "string"
		}
	],
	"user": {}
}
orgRoles Optional

The list of organization roles.


array of ServiceRoles
serviceRolesList Optional

The list of service roles.


user Optional

Defines the properties of User Details.

Errors

Errors

401

Unauthorized - The user is not authorized to use the API


500

Internal Server Error - An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/v1/orgs/{orgId}/users


Feedback

Was this page helpful?