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

Get Group Roles On Organization

Description

Lists the organization and service roles of a specified enterprise group within an organization.

Request

Request

URL

URL


get
https://{api_host}/v1/federation/orgs/{orgId}/groups/{groupId}/roles
Copy

Path Parameters

Path Parameters

string
groupId Required

  • GroupId for which the groups will be fetched, this parameter mandatory


string
orgId Required

  • OrgId for which the roles will be fetched


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns OrgAndServiceRolesForAuth of type application/json
{
	"organizationRoles": {
		"orgRoles": [
			{
				"displayName": "...",
				"id": "...",
				"memberType": "DIRECT",
				"name": "...",
				"orgId": "..."
			},
			{
				"displayName": "...",
				"id": "...",
				"memberType": "GROUP",
				"name": "...",
				"orgId": "..."
			}
		]
	},
	"serviceRoles": [
		{
			"resourceTypes": [
				"...",
				"..."
			],
			"resources": [
				{
					"id": "...",
					"name": "..."
				},
				{
					"id": "...",
					"name": "..."
				}
			],
			"roles": [
				{
					"associatedResources": [
						"...",
						"..."
					],
					"defaultRole": true,
					"displayName": "...",
					"enabled": true,
					"hidden": true,
					"memberType": "DIRECT",
					"mspDefaultRole": true,
					"mspDefaultRoleOfProviderAtTenant": true,
					"name": "...",
					"resource": "...",
					"roleId": "...",
					"status": "..."
				},
				{
					"associatedResources": [
						"...",
						"..."
					],
					"defaultRole": true,
					"displayName": "...",
					"enabled": true,
					"hidden": true,
					"memberType": "GROUP",
					"mspDefaultRole": true,
					"mspDefaultRoleOfProviderAtTenant": true,
					"name": "...",
					"resource": "...",
					"roleId": "...",
					"status": "..."
				}
			],
			"serviceDisplayName": "...",
			"serviceId": "..."
		},
		{
			"resourceTypes": [
				"...",
				"..."
			],
			"resources": [
				{
					"id": "...",
					"name": "..."
				},
				{
					"id": "...",
					"name": "..."
				}
			],
			"roles": [
				{
					"associatedResources": [
						"...",
						"..."
					],
					"defaultRole": true,
					"displayName": "...",
					"enabled": true,
					"hidden": true,
					"memberType": "GROUP",
					"mspDefaultRole": true,
					"mspDefaultRoleOfProviderAtTenant": true,
					"name": "...",
					"resource": "...",
					"roleId": "...",
					"status": "..."
				},
				{
					"associatedResources": [
						"...",
						"..."
					],
					"defaultRole": true,
					"displayName": "...",
					"enabled": true,
					"hidden": true,
					"memberType": "DIRECT",
					"mspDefaultRole": true,
					"mspDefaultRoleOfProviderAtTenant": true,
					"name": "...",
					"resource": "...",
					"roleId": "...",
					"status": "..."
				}
			],
			"serviceDisplayName": "...",
			"serviceId": "..."
		}
	]
}
organizationRoles Optional

The list of organization roles.


array of ServiceRoles
serviceRoles Optional

The list of service roles.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/v1/federation/orgs/{orgId}/groups/{groupId}/roles


Feedback

Was this page helpful?