action dracoon_request_profile_attributes {
label: "Request user profile attributes"
description: "
🚀 Since v4.7.0
\n\n### Description: \nRetrieve a list of user profile attributes.\n\n### Precondition:\nNone.\n\n### Postcondition:\nList of attributes 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[:VALUE...]` \n\n\nExample
\n\n`key:cn:searchString_1|value:cn:searchString_2` \nFilter by attribute key contains `searchString_1` **AND** attribute value contains `searchString_2`.\n\n \n\n### Filtering options:\n\nExpand
\n\n| `FIELD_NAME` | Filter Description | `OPERATOR` | Operator Description | `VALUE` |\n| :--- | :--- | :--- | :--- | :--- |\n| `key` | User profile attribute key filter | `cn, eq, sw` | Attribute key contains / equals / starts with value. | `search String` |\n| `value` | User profile attribute value filter | `cn, eq, sw` | Attribute value contains / equals / starts with value. | `search String` |\n\n \n\n---\n\n### Sorting:\nSort string syntax: `FIELD_NAME:ORDER` \n`ORDER` can be `asc` or `desc`. \nMultiple sort fields are supported. \n\n\nExample
\n\n`key:asc|value:desc` \nSort by `key` ascending **AND** by `value` descending.\n\n \n\n### Sorting options:\n\nExpand
\n\n| `FIELD_NAME` | Description |\n| :--- | :--- |\n| `key` | User profile attribute key |\n| `value` | User profile attribute value |\n\n "
provider: dracoon
method: GET
path: "/v4/user/profileAttributes"
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"
}
sort: {
type: "string"
}
}
additionalProperties: false
}
output: {
type: "object"
description: "Ranged list of attributes"
required: ["items", "range"]
properties: {
items: {
type: "array"
description: "List of key-value pairs"
items: {
type: "object"
description: "Key-value pair"
required: ["key", "value"]
properties: {
key: {
type: "string"
description: "Entry key"
}
value: {
type: "string"
description: "Entry value"
}
}
}
}
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"
}
}
}
}
}
}