Request users with specific role

v1.0.0

Description:

Get all users with a specific role.

Precondition:

Right 🔓 read users required.

Postcondition:

List of users is returned.

Further Information:

Filtering:

All filter fields are connected via logical conjunction (AND)
Filter string syntax: FIELD_NAME:OPERATOR:VALUE

Example

isMember:eq:false|user:cn:searchString
Get all users that are NOT member of that role AND whose (firstName OR lastName OR email OR username) is like searchString.

Filtering options:

Expand

`FIELD_NAME`	Filter Description	`OPERATOR`	Operator Description	`VALUE`
`user`	User filter	`cn`	User contains value (`firstName` OR `lastName` OR `email` OR `username`).	`search String`
`isMember`	Filter the users which are (not) member of that role	`eq`		`true` `false` `any` default: `true`

Deprecated filtering options:

Expand

`FIELD_NAME`	Filter Description	`OPERATOR`	Operator Description	`VALUE`
~~`displayName`~~	User display name filter (use `user` filter)	`cn`	User display name contains value (`firstName` OR `lastName` OR `email`).	`search String`

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    },
    "filter": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "role_id": {
      "type": "integer",
      "format": "int32"
    }
  },
  "required": [
    "role_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List of users with assigned role",
  "required": [
    "items",
    "range"
  ],
  "properties": {
    "items": {
      "type": "array",
      "description": "List of role-user mappings",
      "items": {
        "type": "object",
        "description": "User information",
        "required": [
          "displayName",
          "id",
          "isMember",
          "userInfo"
        ],
        "properties": {
          "displayName": {
            "type": "string",
            "description": "&#128679; Deprecated since v4.11.0\n\nDisplay name\n\nuse information from `UserInfo` instead to combine a display name"
          },
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "&#128679; Deprecated since v4.11.0\n\nUnique identifier for the user\n\nuse `id` from `UserInfo` instead"
          },
          "isMember": {
            "type": "boolean",
            "description": "Is user member of the role"
          },
          "userInfo": {
            "type": "object",
            "description": "User information",
            "required": [
              "avatarUuid",
              "firstName",
              "id",
              "lastName",
              "userName",
              "userType"
            ],
            "properties": {
              "avatarUuid": {
                "type": "string",
                "description": "&#128640; Since v4.11.0\n\nAvatar UUID"
              },
              "displayName": {
                "type": "string",
                "description": "&#128679; Deprecated since v4.11.0\n\nDisplay name\n\nuse other fields from `UserInfo` instead to combine a display name"
              },
              "email": {
                "type": "string",
                "description": "&#128640; Since v4.11.0\n\nEmail "
              },
              "firstName": {
                "type": "string",
                "description": "&#128640; Since v4.11.0\n\nUser first name (mandatory if `userType` is `internal`)"
              },
              "id": {
                "type": "integer",
                "format": "int64",
                "description": "Unique identifier for the user"
              },
              "lastName": {
                "type": "string",
                "description": "&#128640; Since v4.11.0\n\nUser last name (mandatory if `userType` is `internal`)"
              },
              "title": {
                "type": "string",
                "description": "&#128679; Deprecated since v4.18.0\n\nJob title"
              },
              "userName": {
                "type": "string",
                "description": "&#128640; Since v4.13.0\n\nUsername (only returned for `internal` users)"
              },
              "userType": {
                "type": "string",
                "description": "&#128640; Since v4.11.0\n\nUser type:\n\n* `internal` - ordinary DRACOON user\n\n* `external` - external user without DRACOON account\n\n* `system` - system user (non human &#128125;)\n\n* `deleted` - deleted DRACOON user",
                "enum": [
                  "system",
                  "internal",
                  "external",
                  "deleted"
                ]
              }
            }
          }
        }
      }
    },
    "range": {
      "type": "object",
      "description": "Range information",
      "required": [
        "limit",
        "offset",
        "total"
      ],
      "properties": {
        "limit": {
          "type": "integer",
          "format": "int64",
          "description": "Range limit. Maximum 500."
        },
        "offset": {
          "type": "integer",
          "format": "int64",
          "description": "Range offset"
        },
        "total": {
          "type": "integer",
          "format": "int64",
          "description": "Total items available"
        }
      }
    }
  }
}