Member
Manage members, which represent relationships between users, groups, and entities. You can create, update, delete, and search for members with advanced filtering and pagination.
- Version
- 2.0.0
- OpenAPI version
- 3.0.0
Authentication
Section titled “ Authentication ”OAuth2
Section titled “OAuth2 ”Security scheme type: oauth2
Flow type: password
Token URL: https://auth.4hse.com/realms/4hse/protocol/openid-connect/token
AccessToken
Section titled “AccessToken ”Security scheme type: apiKey
Query parameter name: access-token
Operations
Section titled “Operations” POST /v2/member/index
Returns a paginated and filterable list of members. Use POST to allow complex filters via JSON payload.
One of parent_id and `child_id“ must be provided to filter members by their relationships.
Due to optimization, if you provide parent_id only user-related fields will be filled and if you provide child_id only group-related fields will be filled.
Authorizations
Section titled “Authorizations ”Request Body
Section titled “Request Body ”Parameters for searching members
object
Filter by parent_id group to obtain its members
Filter by child_id group to obtain its parent group
Filter by group name to obtain its members
Filter by username to obtain its members
Filter by entity name to obtain its members
object
The unique identifier of the member.
The unique identifier of the parent entity.
The unique identifier of the child entity.
The username of the member.
The email address of the member.
The status of the user (active, inactive, etc.).
The timestamp when the user was created.
The name of the group the member belongs to.
A description of the group, if available.
The status of the group (active, inactive, etc.).
The timestamp when the group was created.
The permission level of the member within the group.
The unique identifier of the entity associated with the parent group.
The name of the entity associated with the parent group.
The type of the entity associated with the parent group (e.g., Project,
The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order
The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.
Example
{ "filter": { "username": "john.doe" }, "per-page": 10, "page": 1, "sort": "username"}Responses
Section titled “ Responses ”List of members
object
The unique identifier of the member.
The unique identifier of the parent entity.
The unique identifier of the child entity.
The username of the member.
The email address of the member.
The status of the user (active, inactive, etc.).
The timestamp when the user was created.
The name of the group the member belongs to.
A description of the group, if available.
The status of the group (active, inactive, etc.).
The timestamp when the group was created.
The permission level of the member within the group.
The unique identifier of the entity associated with the parent group.
The name of the entity associated with the parent group.
The type of the entity associated with the parent group (e.g., Project,
Example
{ "member_id": "mem-1", "parent_id": "grp-1", "child_id": "usr-1", "username": "john.doe", "user_email": "john.doe@example.com", "user_status": "active", "user_created_at": 1700000000, "group_name": "myprojectid-admin", "group_description": "Administrators of My project", "group_status": "active", "group_created_at": "1700000000,", "permission": "admin", "entity_id": "myprojectid", "entity_name": "My project", "entity_type": "Project"}Headers
Section titled “Headers ”Current page
Total number of pages
Number of items per page
Total number of items
create
Section titled “create” POST /v2/member/create
Create a new member by providing the required details.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”Member object to be created
object
Example
{ "parent_id": "grp-2", "child_id": "usr-2"}Responses
Section titled “ Responses ”Member created successfully
object
Example
{ "member_id": "mem-2", "parent_id": "grp-2", "child_id": "usr-2"} GET /v2/member/view/{id}
Retrieve a member by its unique ID.
Authorizations
Section titled “Authorizations ”Path Parameters
Section titled “Path Parameters ”ID of the member to retrieve
Responses
Section titled “ Responses ”Member found
object
The unique identifier of the member.
The unique identifier of the parent entity.
The unique identifier of the child entity.
The username of the member.
The email address of the member.
The status of the user (active, inactive, etc.).
The timestamp when the user was created.
The name of the group the member belongs to.
A description of the group, if available.
The status of the group (active, inactive, etc.).
The timestamp when the group was created.
The permission level of the member within the group.
The unique identifier of the entity associated with the parent group.
The name of the entity associated with the parent group.
The type of the entity associated with the parent group (e.g., Project,
Example
{ "member_id": "mem-1", "parent_id": "grp-1", "child_id": "usr-1", "username": "john.doe", "user_email": "john.doe@example.com", "user_status": "active", "user_created_at": 1700000000, "group_name": "myprojectid-admin", "group_description": "Administrators of My project", "group_status": "active", "group_created_at": "1700000000,", "permission": "admin", "entity_id": "myprojectid", "entity_name": "My project", "entity_type": "Project"}Member not found
delete
Section titled “delete” DELETE /v2/member/delete/{id}
Delete a member by its unique ID. If force=true, all related entities will also be deleted.
Authorizations
Section titled “Authorizations ”Path Parameters
Section titled “Path Parameters ”ID of the member to delete
Query Parameters
Section titled “Query Parameters ”Force the deletion of the entity and all related entities
Responses
Section titled “ Responses ”Member deleted successfully
If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned