Reference Group

Table of Contents

• Get all UAC Groups
• Get UAC Group
• Create UAC Group
• Modify UAC Group
• Delete UAC Group

---

Get all UAC Groups

This method will get information about all UAC groups of the site. It returns one object for each group.

GET https://api.chayns.net/v2.0/{LocationID}/UAC?[filter=value]

Permissions
'PublicInfo', 'UserInfo', 'SeeUAC'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• TappID : int - Can be found in chayns.env.site.tapp

Filter
Name, ShowName, TappId

Result

• name : string - The internal name of the UAC group.
• showName : string - The public name of the UAC group.
• userGroupId : int - The identifier of the UAC group.
• countMember : int - A count of the group members.

---

Get UAC Group

This method will get information about a specific UAC group.

GET https://api.chayns.net/v2.0/{LocationID}/UAC/{GroupID}

Permissions
'PublicInfo', 'UserInfo', 'SeeUAC'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• TappID : int - Can be found in chayns.env.site.tapp
• GroupID : int - Can be found in chayns.env or using the request above.

Result

• name : string - The internal name of the UAC group.
• showName : string - The public name of the UAC group.
• tappId : int - The id of the tapp the groups belongs to.
• userGroupId : int - The identifier of the UAC group.
• countMember : int - A count of the group members.

---

Create UAC Group

This method allows you to create a Tapp-UAC group.

Tapp UAC groups are based on the installed Developer Tapp. If the Tapp is deleted, the UAC group will be removed automaticly.

POST https://api.chayns.net/v2.0/{LocationID}/UAC

Snippet

• Create an UAC group

Permissions
'PublicInfo', 'EditUAC'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Body

• showname : string - The public name of the group.
• name : string - The internal name of the group.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• TappID : int - Can be found in chayns.env.site.tapp.

Result

• name : string - The internal name of the created group.
• showName : string - The public name of the created group.
• userGroupId : int - The identifier of the created group.
• tappId : int - The id of the tapp the group belongs to.
• countMember : int - A counter for all members of the created group. Obviously the value is 0 at this point.

---

Modify UAC Group

This method allows you to modify the name and app name of a Tapp-UAC group.

Tapp UAC groups are based on the installed Developer Tapp. If the Tapp is deleted, the UAC group will be removed automaticly.

PATCH https://api.chayns.net/v2.0/{LocationID}/UAC/{GroupID}

Permissions
'PublicInfo', 'SeeUAC', 'EditUAC'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Body

• showname : string - The public name of the group.
• name : string - The internal name of the group.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• TappID : int - Can be found in chayns.env.site.tapp.
• GroupID : int - Can be found using chayns.env or using the request above for getting all groups.

Result

• name : string - The internal name of the created group.
• showName : string - The public name of the created group.
• userGroupId : int - The identifier of the created group.
• tappId : int - The id of the tapp the group belongs to.
• countMember : int - A counter for all members of the created group. Obviously the value is 0 at this point.

---

Delete UAC Group

This method deletes a Tapp-UAC group.

Tapp UAC groups are based on the installed Developer Tapp. If the Tapp is deleted, the UAC group will be removed automaticly.

DELETE https://api.chayns.net/v2.0/{LocationID}/UAC/{GroupID}

Permissions
'PublicInfo', 'SeeUAC', 'EditUAC'

Header
Authorization: Basic {TappId}:{Secret}

The part 'TappID:Secret' has to be Base64 encoded.

Parameter

• LocationID : int - Can be found in chayns.env.site.
• TappID : int - Can be found in chayns.env.site.tapp.
• GroupID : int - Can be found using chayns.env or using the request above for getting all groups.
• ForceRemoveUacGroup : boolean - The group will be deleted only if it has no members or if this parameter is true.