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

Get Group Roles On Organization By Organization ID And Group ID

Description

Get roles of a group within organization.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️ ✔️

Request

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}/roles
Copy

Path Parameters

Path Parameters

string
groupId Required

Unique identifier of the group.

Parameter Serialization Style: simple Explode:false

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns RolesDto of type application/json
{
	"customRoles": [
		{
			"createdBy": "string",
			"createdDate": "string",
			"expiresAt": 3609941597,
			"lastUpdatedBy": "string",
			"lastUpdatedDate": "string",
			"membershipType": "DIRECT",
			"name": "string",
			"resource": "string"
		}
	],
	"organizationRoles": [
		{
			"createdBy": "string",
			"createdDate": "string",
			"displayName": "string",
			"expiresAt": 3609941597,
			"lastUpdatedBy": "string",
			"lastUpdatedDate": "string",
			"membershipType": "DIRECT",
			"name": "string",
			"resource": "string"
		}
	],
	"serviceRoles": [
		{
			"serviceDefinitionId": "string",
			"serviceRoleNames": [
				"string"
			],
			"serviceRoles": [
				{
					"createdBy": "string",
					"createdDate": "string",
					"expiresAt": 3609941597,
					"lastUpdatedBy": "string",
					"lastUpdatedDate": "string",
					"membershipType": "DIRECT",
					"name": "string",
					"resource": "string"
				}
			]
		}
	]
}
customRoles Optional

List of custom role objects.


organizationRoles Optional

List of organization role objects.


serviceRoles Optional

List of services roles objects.

Errors

Errors

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. | Group 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}/groups/{groupId}/roles
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?