Community Groups

Save PDF

Last UpdatedAug 23, 2023
3 minute read

APIs for getting, updating, and deleting groups for a Community.

`Get all groups for a given community`

List Groups for a Community.

Request

GET /api/v1-preview/Communities/{communityId}/Tenants/{tenantId}/IdentityProviders/{identityProviderId}/Groups
?query={query}&skip={skip}&count={count}

Parameters

string communityId
Community identifier.

string tenantId
Tenant identifier.

string identityProviderId
Identity provider identifier.

[optional] string query
(Not supported) Search string identifier.

[optional] integer skip
Parameter representing the zero-based offset of the first object to retrieve. If unspecified, a default value of 0 is used.

[optional] integer count
Parameter representing the maximum number of objects to retrieve. If unspecified, a default value of 100 is used.

Response

Status Code	Body Type	Description
200	IdentityProviderResultsOfIdentityProviderGroup	Success.
207	IdentityProviderGroupsMultiStatusResponse	None
400	ErrorResponse	Missing or invalid inputs.
401	ErrorResponse	Unauthorized.
403	ErrorResponse	Forbidden.
404	ErrorResponse	Tenant or identity provider not found
500	ErrorResponse	Internal server error.

Example response body

200 Response (IdentityProviderResultsOfIdentityProviderGroup)

{
  "Results": [
    {
      "Id": "string",
      "Name": "string",
      "Email": "user@example.com",
      "IsClusterManagementAllowed": true
    }
  ],
  "SkipToken": "string"
}

`Get Count of Groups for a Community`

Gets Count of Groups for a Community.

Request

HEAD /api/v1-preview/Communities/{communityId}/Tenants/{tenantId}/IdentityProviders/{identityProviderId}/Groups

Parameters

string communityId
Community identifier

string tenantId
Tenant identifier

string identityProviderId
Identity provider identifier.

Response

Status Code	Body Type	Description
200	None	Success
400	ErrorResponse	Bad request
401	ErrorResponse	Unauthorized
403	ErrorResponse	Forbidden
404	ErrorResponse	Community not found
500	ErrorResponse	Internal server error

`Add Group to a Community`

Adds Group to a Community.

Request

PUT /api/v1-preview/Communities/{communityId}/Tenants/{tenantId}/IdentityProviders/{identityProviderId}/Groups/{groupId}

Parameters

string communityId
Community identifier.

string tenantId
Tenant identifier.

string identityProviderId
Identity provider identifier.

string groupId
Group identifier.

Response

Status Code	Body Type	Description
200	IdentityProviderGroup	None
400	ErrorResponse	Bad request
401	ErrorResponse	Unauthorized
403	ErrorResponse	Forbidden
404	ErrorResponse	Tenant or Community not found
500	ErrorResponse	Internal server error

Example response body

200 Response (IdentityProviderGroup)

{
  "Id": "string",
  "Name": "string",
  "Email": "user@example.com",
  "IsClusterManagementAllowed": true
}

`Remove Group from a Community`

Remove Group from a Community.

Request

DELETE /api/v1-preview/Communities/{communityId}/Tenants/{tenantId}/IdentityProviders/{identityProviderId}/Groups/{groupId}

Parameters

string communityId
Community identifier.

string tenantId
Tenant identifier.

string identityProviderId
Identity provider identifier.

string groupId
Group identifier.

Response

Status Code	Body Type	Description
204	None	Created
400	ErrorResponse	Bad request
401	ErrorResponse	Unauthorized
403	ErrorResponse	Forbidden
404	ErrorResponse	Tenant not found
500	ErrorResponse	Internal server error

Definitions

ErrorResponse

Object returned whenever there is an error

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	true	false	Operation identifier of action that caused the error
Error	string	true	false	Error description
Reason	string	true	false	Reason for the error
Resolution	string	true	false	Resolution to resolve the error
DynamicProperties	object	false	true	Additional properties

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "DynamicProperties": {
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}

IdentityProviderResultsOfIdentityProviderGroup

Result object for Identity Provider access users/groups

Properties

Property Name	Data Type	Required	Nullable	Description
Results	[IdentityProviderGroup]	false	false	List of users/groups
SkipToken	string	false	true	Skip token for paging

{
  "Results": [
    {
      "Id": "string",
      "Name": "string",
      "Email": "user@example.com",
      "IsClusterManagementAllowed": true
    }
  ],
  "SkipToken": "string"
}

IdentityProviderGroup

Base class for identity provider access group

Properties

Property Name	Data Type	Required	Nullable	Description
Id	string	false	false	Object identifier of the IdentityProviderGroup
Name	string	false	true	Group name of the IdentityProviderGroup
Email	email	false	true	Email address of the IdentityProviderGroup
IsClusterManagementAllowed	boolean	false	true	Whether group can manage cluster roles

{
  "Id": "string",
  "Name": "string",
  "Email": "user@example.com",
  "IsClusterManagementAllowed": true
}

IdentityProviderGroupsMultiStatusResponse

MultiStatusResponse objects returned in a 207 response

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	false	true	Identifier of the operation that resulted in this error.
Error	string	false	true	Message describing the error.
Reason	string	false	true	Reason that caused the error.
ChildErrors	[MultiStatusResponseChildError]	false	true	List of child errors.
Data	[IdentityProviderGroup]	false	true	Data representing groups.

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "ChildErrors": [
    {
      "OperationId": "string",
      "Error": "string",
      "Reason": "string",
      "Resolution": "string",
      "EventId": "string",
      "StatusCode": 0,
      "ModelId": "string",
      "property1": null,
      "property2": null
    }
  ],
  "Data": [
    {
      "Id": "string",
      "Name": "string",
      "Email": "user@example.com",
      "IsClusterManagementAllowed": true
    }
  ]
}

MultiStatusResponseChildError

ChildError objects returned in a 207 response

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	true	false	OperationId of action that caused the error
Error	string	true	false	Error description
Reason	string	true	false	Reason for the error
Resolution	string	true	false	Resolution for the error
EventId	string	true	false	EventId for the error
StatusCode	int32	false	false	Http status code
ModelId	string	false	true	Model identifier

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "EventId": "string",
  "StatusCode": 0,
  "ModelId": "string",
  "property1": null,
  "property2": null
}

CONNECT data services developer documentation