[{"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

URL

get

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

Copy

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

This operation uses the following authentication methods.

csp-auth-token

Response

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": "..."
		}
	]
}

OrgRoles

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

cURL Command

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

[{"label":"Latest (1.0)","version":"latest"}]

cloud-partner-navigator

Federation Operations

post

Assign Groups On Organization

delete

Delete Groups On Org

get

Get Group Roles On Organization

get

Get IDP ID

get

Get Org Bindings For Group

get

Get Organization Groups

get

Get Users In Group

get

Get Users In Group Within Organization

get

Search Groups

patch

Update Group Roles On Organization

Get Group Roles On Organization

Request

URL

Path Parameters

Authentication

csp-auth-token

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

On This Page

Federation Operations

Was this page helpful?