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

Get User Service Roles By User ID And Organization ID

Description

Get user service roles in an organization.
The query parameter ‘serviceDefinitionLink’ is used for filtering for specific service definition.

Access Policy

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

Request

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/service-roles
Copy

Path Parameters

Path Parameters

string
userId Required

The userId or user account identifier.

Parameter Serialization Style: simple Explode:false

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Query Parameters

Query Parameters

string
serviceDefinitionLink Optional

The Service definition link.

Parameter Serialization Style: form Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns UserServiceRolesResponse of type application/json
{
	"serviceRoles": [
		{
			"serviceDefinitionLink": "string",
			"serviceRoleNames": [
				"string"
			],
			"serviceRoles": [
				{
					"createdBy": "string",
					"createdDate": "string",
					"expiresAt": 3609941597,
					"lastUpdatedBy": "string",
					"lastUpdatedDate": "string",
					"membershipType": "DIRECT",
					"name": "string",
					"resource": "string"
				}
			]
		}
	]
}
array of ServiceRolesDto
serviceRoles Optional

List of services roles objects.

Errors

Errors

CspErrorResponse
401

The user is not authorized to use the API


CspErrorResponse
403

The user is forbidden to use the API


CspErrorResponse
404

User not found | Organization not found


CspErrorResponse
429

The user has sent too many requests


CspErrorResponse
500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/service-roles
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?