Community Users
- Last UpdatedJul 27, 2023
- 3 minute read
APIs for getting, updating, and deleting users from communities
Add User to a Community
Adds a user to a community and provides a list of community role identifiers to be assigned to the user
Request
PUT /api/v1-preview/Communities/{communityId}/Tenants/{tenantId}/Users/{userId}
Parameters
string communityId
Community identifierstring tenantId
Tenant identifierstring userId
User identifier
Request Body
List of community roles Ids to assign to the user
[
"string"
]
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | User | Ok |
| 201 | User | Created |
| 400 | ErrorResponse | Bad request |
| 401 | ErrorResponse | Unauthorized |
| 403 | ErrorResponse | Forbidden |
| 404 | ErrorResponse | Tenant not found |
| 500 | ErrorResponse | Internal server error |
Example response body
200 Response (User)
{
"Id": "string",
"GivenName": "string",
"Surname": "string",
"Name": "string",
"Email": "user@example.com",
"ContactEmail": "user@example.com",
"ContactGivenName": "string",
"ContactSurname": "string",
"ExternalUserId": "string",
"IdentityProviderId": "string",
"RoleIds": [
"string"
]
}
Remove User from a Community
Removes a user from a community
Request
DELETE /api/v1-preview/Communities/{communityId}/Tenants/{tenantId}/Users/{userId}
Parameters
string communityId
Community identifierstring tenantId
Tenant identifierstring userId
User identifier
Response
| Status Code | Body Type | Description |
|---|---|---|
| 204 | None | Removed |
| 400 | ErrorResponse | Bad request |
| 401 | ErrorResponse | Unauthorized |
| 403 | ErrorResponse | Forbidden |
| 404 | ErrorResponse | Tenant not found |
| 500 | ErrorResponse | Internal server error |
List Users of a Tenant in a Community
Gets users that are associated with a specific tenant and community
Request
GET /api/v1-preview/Communities/{communityId}/Tenants/{tenantId}/Users
?query={query}&skip={skip}&count={count}
Parameters
string communityId
Community identifierstring tenantId
Tenant 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 | User[] | Set of users (type User) associated with the tenant ( tenantId) and community ( communityId) |
| 400 | ErrorResponse | Bad request |
| 401 | ErrorResponse | Unauthorized |
| 403 | ErrorResponse | Forbidden |
| 404 | ErrorResponse | Community roles not found |
| 500 | ErrorResponse | Internal server error |
Example response body
200 Response (User[])
[
{
"Id": "string",
"GivenName": "string",
"Surname": "string",
"Name": "string",
"Email": "user@example.com",
"ContactEmail": "user@example.com",
"ContactGivenName": "string",
"ContactSurname": "string",
"ExternalUserId": "string",
"IdentityProviderId": "string",
"RoleIds": [
"string"
]
}
]
Get Count of Users of a Tenant in a Community
Gets the count of users of the tenant in a community.
Request
HEAD /api/v1-preview/Communities/{communityId}/Tenants/{tenantId}/Users
Parameters
string communityId
Community identifierstring tenantId
Tenant identifier
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | None | Success |
| 400 | ErrorResponse | Bad request |
| 401 | ErrorResponse | Unauthorized |
| 403 | ErrorResponse | Forbidden |
| 404 | ErrorResponse | Community roles not found |
| 500 | ErrorResponse | Internal server error |
Definitions
User
Object for retrieving a user
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | guid | false | false | User identifier |
| GivenName | string | false | true | Given name of the user |
| Surname | string | false | true | Surname of the user |
| Name | string | false | true | Name of the user |
| false | true | Email of the user | ||
| ContactEmail | false | true | Contact email for the user. User will only be contacted through this email. | |
| ContactGivenName | string | false | true | Preferred given name for the user |
| ContactSurname | string | false | true | Preferred contact surname for the user |
| ExternalUserId | string | false | true | Provider identifier for the user. This is the identifier we get from the identity provider. |
| IdentityProviderId | guid | false | true | Identity provider identifier used to authenticate the user. This cannot be set to null, and must be set when creating a new user. |
| RoleIds | string[] | false | true | List of roles to be assigned to this client. Member role is always required. For security reasons we advise against assigning administrator role to a client. |
{
"Id": "string",
"GivenName": "string",
"Surname": "string",
"Name": "string",
"Email": "user@example.com",
"ContactEmail": "user@example.com",
"ContactGivenName": "string",
"ContactSurname": "string",
"ExternalUserId": "string",
"IdentityProviderId": "string",
"RoleIds": [
"string"
]
}
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
}