View a User Group by Group Name
get
/api/restapi/applicationUserGroup/groupName/{groupName}
This endpoint returns user groups whose group name matches the value of the {groupName} path parameter.
Request
Path Parameters
-
groupName(required): string
The name of a user group.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityApplicationUserGroup>
Type:
array
Title:
Show Source
List<ApiEntityApplicationUserGroup>
-
Array of:
object ApiEntityApplicationUserGroup
Title:
ApiEntityApplicationUserGroup
Nested Schema : ApiEntityApplicationUserGroup
Type:
object
Title:
Show Source
ApiEntityApplicationUserGroup
-
applicationUserGroupId: integer
(int64)
The unique identifier of a user group. This value should not be provided in create operation request data, however, it is required for update requests.
-
groupName: string
Minimum Length:
0
Maximum Length:255
Name of a user group. -
ldapGuid: string
Minimum Length:
0
Maximum Length:255
Globally unique identifier of an LDAP service. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
scope: string
Allowed Values:
[ "PROJECT", "WORKSPACE" ]
Type of a user group. -
scopeCode: string
Maximum Length:
60
The unique identifier for a project/workspace set by the user who created the project/workspace. -
scopeId: integer
(int64)
The unique identifier of a project/workspace.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
204 Response
Successful operation with no content.
404 Response
The requested user group does not exist, or you do not have access to it.