action dracoon_request_role_groups {
label: "Request groups with specific role"
description: "### Description: \nGet all groups with a specific role.\n\n### Precondition:\nRight 🔓 read groups required.\n\n### Postcondition:\nList of to the role assigned groups is returned.\n\n### Further Information:\n\n### Filtering:\nAll filter fields are connected via logical conjunction (**AND**) \nFilter string syntax: `FIELD_NAME:OPERATOR:VALUE` \n\n\nExample
\n\n`isMember:eq:false|name:cn:searchString` \nGet all groups that are **NOT** a member of that role **AND** whose name contains `searchString`.\n\n \n\n### Filtering options:\n\nExpand
\n\n| `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` |\n| :--- | :--- | :--- | :--- | :--- |\n| `isMember` | Filter the groups which are (not) member of that role | `eq` | | default: `true` |\n| `name` | Group name filter | `cn` | Group name contains value. | `search String` |\n\n "
provider: dracoon
method: GET
path: "/v4/roles/{role_id}/groups"
encoding: json
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"
}
}
}
}
}
}