Jump to

• Request
• Response

Create a User Group

post

/api/restapi/applicationUserGroup

Send a request to this endpoint to create a user group.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root 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.

• applicationUserGroupId
• groupName,scopeId,workspaceId
• groupName,scopeId,workspaceCode
• groupName,scopeCode,workspaceId
• groupName,scopeCode,workspaceCode

Show Source

• 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: string
  Minimum 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.

{
    "title":"ApiEntityApplicationUserGroupInput",
    "required":[
        "groupName",
        "scope",
        "scopeId",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeId":{
            "type":"integer",
            "description":"The unique identifier of a project/workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "type":"string",
            "description":"Type of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT",
                "WORKSPACE"
            ]
        },
        "applicationUserGroupId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "groupName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Name of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ldapGuid":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Globally unique identifier of an LDAP service.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project/workspace set by the user who created the project/workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ApplicationUserGroup object, a unique ApplicationUserGroup object can be identified by the following combinations of the fields.<ul><li>applicationUserGroupId</li><li>groupName,scopeId,workspaceId</li><li>groupName,scopeId,workspaceCode</li><li>groupName,scopeCode,workspaceId</li><li>groupName,scopeCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create a User Group

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityApplicationUserGroup

Type: object

Title: ApiEntityApplicationUserGroup

Show Source

• 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.

{
    "title":"ApiEntityApplicationUserGroup",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeId":{
            "type":"integer",
            "description":"The unique identifier of a project/workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "type":"string",
            "description":"Type of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT",
                "WORKSPACE"
            ]
        },
        "applicationUserGroupId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "groupName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Name of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ldapGuid":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Globally unique identifier of an LDAP service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project/workspace set by the user who created the project/workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the user group service.

Back to Top