Request user profile attributes

v1.0.0

🚀 Since v4.7.0

Description:

Retrieve a list of user profile attributes.

Precondition:

None.

Postcondition:

List of attributes is returned.

Further Information:

Filtering:

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

Example

key:cn:searchString_1|value:cn:searchString_2
Filter by attribute key contains searchString_1 AND attribute value contains searchString_2.

Filtering options:

Expand

`FIELD_NAME`	Filter Description	`OPERATOR`	Operator Description	`VALUE`
`key`	User profile attribute key filter	`cn, eq, sw`	Attribute key contains / equals / starts with value.	`search String`
`value`	User profile attribute value filter	`cn, eq, sw`	Attribute value contains / equals / starts with value.	`search String`

Sorting:

Sort string syntax: FIELD_NAME:ORDER
ORDER can be asc or desc.
Multiple sort fields are supported.

Example

key:asc|value:desc
Sort by key ascending AND by value descending.

Sorting options:

Expand

`FIELD_NAME`	Description
`key`	User profile attribute key
`value`	User profile attribute value

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"
        }
      }
    }
  }
}