Batch Create User Groups
post
/primeapi/restapi/applicationUserGroup/batch
Send a request to this endpoint to create one or more user groups.
Request
Supported Media Types
- application/json
One or more user group objects.
Root Schema : List<ApiEntityApplicationUserGroup>
Type:
array
Title:
Show Source
List<ApiEntityApplicationUserGroup>
Nested 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.
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Nested 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.
400 Response
Invalid input for the user group service.