Avid NEXIS Management API

Appearance

User Groups ​

An user group can have attributes that grant all members the same privileges or functions. Members are users that belongs to a user group.

Get all user groups ​

GET /usergroups Get all user groups.

Request Example:

bash
curl --location '{{url}}/usergroups' \
--header 'token;'

Get a user group by Id ​

GET /usergroups/userGroupId Get an user group by Id.

Request Example:

bash
curl --location '{{url}}/usergroups/{{id}}' \
--header 'token;'

Create a user group ​

POST /usergroups Create an user group.

Required parameter for creating a new user group is the name field.

Request Example:

bash
curl --location '{{url}}/usergroups' \
--header 'token;' \
--header 'Content-Type: application/json' \
--data '{
    "name": "test",
    "userMemberships": [
        {
            "name": "Guest",
            "membership": "member"
        }
    ]
}'

Update a user group by Id ​

PUT /usergroups/userGroupId Update an user group by Id.

Request Example:

bash
curl --location --request PUT '{{url}}/usergroups/{{id}}' \
--header 'token;' \
--header 'Content-Type: application/json' \
--data '{
    "name": "test",
    "userMemberships": [
        {
            "name": "Guest",
            "membership": "non-member"
        }
    ]
}'

Delete a user group ​

DELETE /usergroups/userGroupId Delete an user group by Id.

Request Example:

bash
curl --location --request DELETE '/usergroups/{{id}}' \
--header 'token;'

Useful References ​

Avid NEXIS Official Documentation