View a User Group by Name
get
/primeapi/restapi/applicationUserGroup/name/{name}
This endpoint returns user groups that meet the following requirements:
- The object has a name that matches the value of the {name} path parameter.
Request
Path Parameters
-
name: string
The name of a user group.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityApplicationUserGroup
Type:
Show Source
object
-
groupName(optional):
string
Allowed Values:
[ "Length[1-255]" ]
The name of the User Group. -
ldapGuid(optional):
string
Allowed Values:
[ "Length[1-255]" ]
Globally unique identifier of an LDAP service. -
link(optional):
string(url)
Read Only:
true
-
scope(optional):
string
Allowed Values:
[ "PROJECT", "WORKSPACE" ]
Type of a user group. -
scopeId(optional):
integer(int64)
The unique identifier of a FK.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
userGroupId(optional):
integer(int64)
The unique identifier of a user group.
-
workspaceId(optional):
integer(int64)
The unique identifier of a workspace.
204 Response
Successful operation with no content.
404 Response
The requested user group does not exist, or you do not have access to it.