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

Get Group In Organization By Organization ID And Group ID

Description

Get details 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}
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

string
groupId Required

Unique identifier of the group.

Parameter Serialization Style: simple Explode:false

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ExpandedGroupDto of type application/json
{
	"customRoles": [
		{
			"createdBy": "string",
			"createdDate": "string",
			"expiresAt": 3609941597,
			"lastUpdatedBy": "string",
			"lastUpdatedDate": "string",
			"membershipType": "DIRECT",
			"name": "string",
			"resource": "string"
		}
	],
	"description": "string",
	"displayName": "string",
	"domain": "string",
	"groupType": "USER_GROUP",
	"id": "string",
	"organizationRoles": [
		{
			"createdBy": "string",
			"createdDate": "string",
			"displayName": "string",
			"expiresAt": 3609941597,
			"lastUpdatedBy": "string",
			"lastUpdatedDate": "string",
			"membershipType": "DIRECT",
			"name": "string",
			"resource": "string"
		}
	],
	"ownerOrgId": "string",
	"serviceRoles": [
		{
			"serviceDefinitionId": "string",
			"serviceRoleNames": [
				"string"
			],
			"serviceRoles": [
				{
					"createdBy": "string",
					"createdDate": "string",
					"expiresAt": 3609941597,
					"lastUpdatedBy": "string",
					"lastUpdatedDate": "string",
					"membershipType": "DIRECT",
					"name": "string",
					"resource": "string"
				}
			]
		}
	],
	"sharedOrgIds": [
		"string"
	],
	"usersCount": 0
}
customRoles Optional

The custom roles of the group.


string
description Optional

Description of the custom group. For enterprise groups the value will be null.


string
displayName Optional

The display name of the group.


string
domain Optional

The domain name of the group.


string
groupType Optional

USER_GROUP is an organization specific custom group, AD_GROUP is a federated domain group, SHARED_GROUP is group owned by another organization and shared with current one.

Possible values are: USER_GROUPAD_GROUPDOMAIN_GROUPSHARED_GROUP


string
id Optional

Unique identifier of the group.


organizationRoles Optional

The organization roles of the group.


string
ownerOrgId Optional

Unique identifier (GUID) of the organization that is the owner of the current group.


serviceRoles Optional

The service roles of the group.


array of string
sharedOrgIds Optional

Unique identifiers (GUID) of the shared organizations.


integer as int32
usersCount Optional

Number of users in the group.

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

PowerCLI Client SDK Example

Invoke-GetGroupInOrganizationUsingGET -OrgId "MyOrgId" -GroupId "MyGroupId"

cURL Command

curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}
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?