Batch Create User Groups
post
/api/restapi/applicationUserGroup/batch
Send a request to this endpoint to create one or more user groups.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityApplicationUserGroupInput>
Type:
array
Title:
Show Source
List<ApiEntityApplicationUserGroupInput>
-
Array of:
object ApiEntityApplicationUserGroupInput
Title:
ApiEntityApplicationUserGroupInput
This entity represents a ApplicationUserGroup object, a unique ApplicationUserGroup object can be identified by the following combinations of the fields.- applicationUserGroupId
- groupName,scopeId,workspaceId
- groupName,scopeId,workspaceCode
- groupName,scopeCode,workspaceId
- groupName,scopeCode,workspaceCode
Nested Schema : ApiEntityApplicationUserGroupInput
Type:
object
Title:
ApiEntityApplicationUserGroupInput
This entity represents a ApplicationUserGroup object, a unique ApplicationUserGroup object can be identified by the following combinations of the fields.
Show Source
- applicationUserGroupId
- groupName,scopeId,workspaceId
- groupName,scopeId,workspaceCode
- groupName,scopeCode,workspaceId
- groupName,scopeCode,workspaceCode
-
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(required): string
Minimum Length:
0
Maximum Length:255
Name of a user group. -
ldapGuid: stringMinimum Length:0
Maximum Length:255
Deprecated. As of 24.4.Globally unique identifier of an LDAP service. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
scope(required): 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(required): integer
(int64)
The unique identifier of a project/workspace.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
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.
400 Response
Invalid input for the user group service.