Get Auto Join Group from Auto Join Groups of a Auth Module
Request
GET [[[<REST API URL>|Hub-Rest-Api-URL.html]]]/authmodules/auth module id/autojoingroups/auto join group id?fields=string
Parameter | Description |
---|---|
| Optional. Returns only the specified subset of the fields for each AutoJoinGroup. Use Fields Syntax to define the subset. |
Response
Response Code | Meaning |
---|---|
200 OK | Successful request. |
400 Bad Request | At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response. |
403 Forbidden | The requester has no access to the requested resource. |
404 Not Found | The requested resource was not found. |
500 Internal Server Error | Failed to process request because of the server error. For details, check the error message in the response. |
Response body
{
"description": string,
"iconUrl": string,
"autoJoin": boolean,
"autoJoinDomain": string,
"requiredTwoFactorAuthentication": boolean,
"parentsRequireTwoFactorAuthentication": boolean,
"users": [[[[user|HUB-REST-API_JSON-Scheme.html#user]]], ...],
"ownUsers": [[[[user|HUB-REST-API_JSON-Scheme.html#user]]], ...],
"userCount": int,
"parent": [[[userGroup|HUB-REST-API_JSON-Scheme.html#userGroup]]],
"subgroups": [[[[userGroup|HUB-REST-API_JSON-Scheme.html#userGroup]]], ...],
"teams": [[[[projectTeam|HUB-REST-API_JSON-Scheme.html#projectTeam]]], ...],
"organizations": [[[[organization|HUB-REST-API_JSON-Scheme.html#organization]]], ...],
"project": [[[project|HUB-REST-API_JSON-Scheme.html#project]]],
"allUsers": boolean,
"registeredUsers": boolean,
"implicit": boolean,
"queriedSingleton": boolean,
"removable": boolean,
"immutable": boolean,
"importedFromAuthModule": [[[externalauthmodule|HUB-REST-API_JSON-Scheme.html#externalauthmodule]]],
"mappedInAuthModule": [[[externalauthmodule|HUB-REST-API_JSON-Scheme.html#externalauthmodule]]],
"idpGroupId": string,
"idpGroupName": string,
"idpStatus": [[[userGroupIdpStatus|HUB-REST-API_JSON-Scheme.html#userGroupIdpStatus]]],
"idpGroupNameOverridden": boolean,
"id": string /* from authorityHolder */,
"aliases": [[[[alias|HUB-REST-API_JSON-Scheme.html#alias]]], ...] /* from authorityHolder */,
"name": string /* from authorityHolder */,
"projectRoles": [[[[projectRole|HUB-REST-API_JSON-Scheme.html#projectRole]]], ...] /* from authorityHolder */,
"transitiveProjectRoles": [[[[projectRole|HUB-REST-API_JSON-Scheme.html#projectRole]]], ...] /* from authorityHolder */,
"sourcedProjectRoles": [[[[sourcedProjectRole|HUB-REST-API_JSON-Scheme.html#sourcedProjectRole]]], ...] /* from authorityHolder */,
"organizationRoles": [[[[organizationRole|HUB-REST-API_JSON-Scheme.html#organizationRole]]], ...] /* from authorityHolder */,
"transitiveOrganizationRoles": [[[[organizationRole|HUB-REST-API_JSON-Scheme.html#organizationRole]]], ...] /* from authorityHolder */,
"sourcedOrganizationRoles": [[[[sourcedOrganizationRole|HUB-REST-API_JSON-Scheme.html#sourcedOrganizationRole]]], ...] /* from authorityHolder */
}
14 October 2024