Add Auto Join Group to Auto Join Groups of a Auth Module
Request
POST <REST API URL>
/authmodules/{auth module id
}/autojoingroups?fields=string
Parameter | Description |
---|---|
fields | Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset. |
Request Body
userGroup
extends authorityHolder
{
"description": string,
"iconUrl": string,
"autoJoin": boolean,
"users": [user
, ...],
"ownUsers": [user
, ...],
"userCount": int,
"parent": userGroup
,
"subgroups": [userGroup
, ...],
"teams": [projectTeam
, ...],
"project": project
,
"allUsers": boolean,
"implicit": boolean,
"queriedSingleton": boolean,
"id": string /* from authorityHolder */
,
"aliasIds": [string, ...] /* from authorityHolder */
,
"aliases": [alias, ...] /* from authorityHolder */
,
"name": string /* from authorityHolder */
,
"projectRoles": [projectRole, ...] /* from authorityHolder */
,
"transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */
}
Response
Response Code | Meaning |
---|---|
200 OK | Successful request. |
400 Bad Request | Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error. |
403 Forbidden | Requester has no access to the request. |
404 Not Found | Requested resource wasn't found. |
500 Internal Server Error | Failed to process request because of the server error. The response contains message describing the error. |
Response body
userGroup
extends authorityHolder
{
"description": string,
"iconUrl": string,
"autoJoin": boolean,
"users": [user
, ...],
"ownUsers": [user
, ...],
"userCount": int,
"parent": userGroup
,
"subgroups": [userGroup
, ...],
"teams": [projectTeam
, ...],
"project": project
,
"allUsers": boolean,
"implicit": boolean,
"queriedSingleton": boolean,
"id": string /* from authorityHolder */
,
"aliasIds": [string, ...] /* from authorityHolder */
,
"aliases": [alias, ...] /* from authorityHolder */
,
"name": string /* from authorityHolder */
,
"projectRoles": [projectRole, ...] /* from authorityHolder */
,
"transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */
}
Last modified: 20 November 2017