Request groups with specific role

v1.0.0

Description:

Get all groups with a specific role.

Precondition:

Right 🔓 read groups required.

Postcondition:

List of to the role assigned groups 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|name:cn:searchString
Get all groups that are NOT a member of that role AND whose name contains searchString.

Filtering options:

Expand

`FIELD_NAME`	Filter Description	`OPERATOR`	Operator Description	`VALUE`
`isMember`	Filter the groups which are (not) member of that role	`eq`		`true` `false` `any` default: `true`
`name`	Group name filter	`cn`	Group name contains value.	`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 groups with assigned role",
  "required": [
    "items",
    "range"
  ],
  "properties": {
    "items": {
      "type": "array",
      "description": "List of role-group mappings",
      "items": {
        "type": "object",
        "description": "Group information",
        "required": [
          "id",
          "isMember",
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "Unique identifier for the group"
          },
          "isMember": {
            "type": "boolean",
            "description": "Is group member of the role"
          },
          "name": {
            "type": "string",
            "description": "Group name"
          }
        }
      }
    },
    "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"
        }
      }
    }
  }
}