User Groups

Find user groups

get

Returns user groups matching the given search criteria. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. By default a result containing 1000 user groups is returned.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

namestringOptional

The name of the user group.

nameMatchModestring · enumOptional

The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive.

Default: ANYWHEREPossible values:

userIdstring · uuidOptional

The ID of the user who should belong to searched user groups.

includeEveryonebooleanOptional

Indicates if we should include the everyone group or not.

Responses

200

Search completed

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/userGroups

HTTPcURLJavaScriptPython

GET /rest/2.0/userGroups HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Search completed

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "name": "Test name",
      "locallyManaged": true
    }
  ]
}

Add new user group

post

Adds a new user group.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Body

application/json

namestring · min: 1 · max: 255Required

The name of the user group. Should be unique within all user groups.

locallyManagedbooleanOptionalDeprecated

The locallyManaged flag of the user group. Indicates whether this UserGroup is locally managed or not.

Responses

201

User group successfully added.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

locallyManagedbooleanOptional

post/userGroups

HTTPcURLJavaScriptPython

POST /rest/2.0/userGroups HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

201

User group successfully added.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "locallyManaged": true
}

Add users to user group

post

Adds users to an existing user group.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

userGroupIdstring · uuidRequired

The ID of the user group

Body

application/json

userGroupIdstring · uuidRequired

The ID of the user group the users should be added to. Silently ignored if the ID is provided as path parameter of the request.

userIdsstring · uuid[] · min: 1 · max: 2147483647Required

The list of IDs of the users that should be added to the user group.

Responses

200

Users successfully added to user group.

application/json

Represents a user in the system.

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

userNamestringOptional

The user name.

firstNamestringOptional

The first name of the user.

lastNamestringOptional

The last name of the user.

titlestringOptional

The organizational title of the user.

departmentstringOptional

The organizational department of the user.

emailAddressstringOptional

The main email address.

genderstring · enumOptional

The gender of the user.

Possible values:

languagestringOptional

The current language preference for this user.

activatedbooleanOptional

Whether this user account is already activated or not.

enabledbooleanOptional

Whether this user account is already enabled or not.

ldapUserbooleanOptional

Whether this is an LDAP user or not.

userSourcestring · enumOptionalPossible values:

guestUserbooleanOptional

Whether this is a guest user or not.

apiUserbooleanOptionalDeprecated

Whether this is API user or not. This field is no longer used and will be removed in the future.

licenseTypestring · enumOptionalDeprecated

This field represents the given license which is no longer used, so the method no longer returns useful data and will be removed in the future. To retrieve the user's required license type based on their permissions, please use GET /users/{userId}/licenseType

Possible values:

404

User group not found

post/userGroups/{userGroupId}/users

HTTPcURLJavaScriptPython

POST /rest/2.0/userGroups/{userGroupId}/users HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "userGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "userName": "text",
    "firstName": "text",
    "lastName": "text",
    "title": "text",
    "department": "text",
    "emailAddress": "text",
    "gender": "MALE",
    "language": "text",
    "additionalEmailAddresses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "emailAddress": "text"
      }
    ],
    "phoneNumbers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "type": "FAX",
        "phoneNumber": "text"
      }
    ],
    "instantMessagingAccounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "account": "text",
        "type": "AOL"
      }
    ],
    "websites": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "url": "text",
        "type": "FACEBOOK"
      }
    ],
    "addresses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "city": "text",
        "street": "text",
        "number": "text",
        "state": "text",
        "country": "text",
        "postalCode": "text",
        "type": "HOME"
      }
    ],
    "activated": true,
    "enabled": true,
    "ldapUser": true,
    "userSource": "INTERNAL",
    "guestUser": true
  }
]

Remove users from user group

delete

Removes users from the user group with the given ID

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

userGroupIdstring · uuidRequired

The ID of the user group

Body

application/json

userGroupIdstring · uuidRequired

The ID of the user groups from which the users should be removed.
Silently ignored if the ID is provided as path parameter of the request.

userIdsstring · uuid[] · min: 1 · max: 2147483647Required

The list of IDs of the users which should be removed from the user group.

Responses

200

Users removed from user group

No content

404

User group not found

delete/userGroups/{userGroupId}/users

HTTPcURLJavaScriptPython

DELETE /rest/2.0/userGroups/{userGroupId}/users HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "userGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

Get user group

get

Returns the user group with the given ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

userGroupIdstring · uuidRequired

The ID of the user group

Responses

200

User group found

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

locallyManagedbooleanOptional

404

User group not found

get/userGroups/{userGroupId}

HTTPcURLJavaScriptPython

GET /rest/2.0/userGroups/{userGroupId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "locallyManaged": true
}

Remove user group

delete

Removes the user group with the given ID

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

userGroupIdstring · uuidRequired

The ID of the user group

Responses

200

User group removed

No content

404

User group not found

delete/userGroups/{userGroupId}

HTTPcURLJavaScriptPython

DELETE /rest/2.0/userGroups/{userGroupId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Change user group

patch

Changes the user group with the information that is present in the request. Only properties that are specified in this request and have not null values are updated. All other properties are ignored.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Path parameters

userGroupIdstring · uuidRequired

The ID of the user group

Body

application/json

namestring · min: 1 · max: 2147483647Required

The name of the user group. Should be unique within all user groups.

locallyManagedbooleanOptionalDeprecated

The locallyManaged flag of the user group. Indicates whether this UserGroup is locally managed or not.

Responses

200

User group changed

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

locallyManagedbooleanOptional

404

User group not found

patch/userGroups/{userGroupId}

HTTPcURLJavaScriptPython

PATCH /rest/2.0/userGroups/{userGroupId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "locallyManaged": true
}