User Groups

User Groups are collections of users, which facilitate task assignment and task completion priviledges in Validere.

https://api.validere.io/app

Create a User Group

Create a user group

post
Authorizations
Body
namestringOptional
descriptionstringOptional
group_category_idstring · uuidOptional
Responses
200

A successful operation

application/json
Responseall of
and
post
/app/v1/user_groups
200

A successful operation

Delete a User Group

Delete a user group

delete
Authorizations
Path parameters
user_group_idstring · uuidRequired

User Group ID

Responses
200

successful operation

No content

delete
/app/v1/user_groups/{user_group_id}
200

successful operation

No content

Update a User Group

Update a user group

put
Authorizations
Path parameters
user_group_idstring · uuidRequired

User Group ID

Body
namestringOptional
descriptionstringOptional
group_category_idstring · uuidOptional
Responses
200

A successful operation

application/json
Responseall of
and
put
/app/v1/user_groups/{user_group_id}
200

A successful operation

Get a User Group

Get a user group

get
Authorizations
Path parameters
user_group_idstring · uuidRequired

User Group ID

Responses
200

A successful operation

application/json
Responseall of
and
get
/app/v1/user_groups/{user_group_id}
200

A successful operation

Search User Groups

Search user groups

post
Authorizations
Body
objectOptional
and
and
Responses
200

successful operation

application/json
Responseall of
post
/app/v1/user_groups/search
200

successful operation

Get User Group Members

Show Memberships for a user group

get
Authorizations
Path parameters
user_group_idstring · uuidRequired

User Group ID

Responses
200

A successful operation

application/json
get
/app/v1/user_groups/{user_group_id}/members
200

A successful operation

Add User to User Group

Add a user to a user group

put
Authorizations
Path parameters
user_group_idstring · uuidRequired

User Group ID

member_idstring · uuidRequired

Member ID

Responses
200

A successful operation

No content

put
/app/v1/user_groups/{user_group_id}/members/{member_id}
200

A successful operation

No content

Remove User From User Group

Remove a user from a user group

delete
Authorizations
Path parameters
user_group_idstring · uuidRequired

User Group ID

member_idstring · uuidRequired

Member ID

Responses
200

A successful operation

No content

delete
/app/v1/user_groups/{user_group_id}/members/{member_id}
200

A successful operation

No content

Create User Group Category

Create a Group Category

post
Authorizations
Body
namestring · max: 100Optional
descriptionstring · max: 256Optional
Responses
200

A successful operation

application/json
Responseall of
and
post
/app/v1/group_categories
200

A successful operation

Get User Group Category

Get a Group Category

get
Authorizations
Path parameters
idstring · uuidRequired

Group Category ID

Responses
200

A successful operation

application/json
Responseall of
and
get
/app/v1/group_categories/{id}
200

A successful operation

Update User Group Category

Update a Group Category

put
Authorizations
Path parameters
idstring · uuidRequired

Group Category ID

Body
namestring · max: 100Optional
descriptionstring · max: 256Optional
Responses
200

A successful operation

application/json
Responseall of
and
put
/app/v1/group_categories/{id}
200

A successful operation

Delete User Group Category

Delete a Group Category

delete
Authorizations
Path parameters
idstring · uuidRequired

Group Category ID

Responses
200

A successful operation

No content

delete
/app/v1/group_categories/{id}
200

A successful operation

No content

Search User Group Categories

Search Group Categories

post
Authorizations
Body
anyOptional
and
and
Responses
200

Successfully operation

application/json
Responseall of
post
/app/v1/group_categories/search
200

Successfully operation

Last updated