Benutzer anhand von Attribut vom Server abrufen

Benutzer anhand von Attribut vom Server abrufenServer-side

post/attributes/users/get

Gets a list of users by an attribute. Returns a list of the users’ IDs, their emails, and the attributes that were specified in the ‘key’ object of the request.

Notice
Rate limits for server-side methods are applied to this method.

SecurityAttributesServer

Request

Request Body schema: application/json

required

object

Das Attribut dient dazu, die Benutzerliste abzurufen.

key required	string <= 256 characters [A-Za-z0-9_]+ Name des Attributs, anhand dessen das Benutzerattribut identifiziert wird. Muss für jeden Benutzer eindeutig sein.
value	string or null Wert des Benutzerattributs. Erforderlich, um Benutzer abzurufen, deren `key`-Parameter diesen Wert aufweist. Ist kein Wert angegeben, werden alle Benutzer mit einem Wert für diesen Schlüssel zurückgegeben.

after

string or null

Aktualisierungsdatum des Benutzerattributs und ID des neusten Attributs in der keys-Liste. Legen Sie das Datum nicht beim ersten Mal fest. Wenn Sie Benutzer anhand eines Attributs abrufen, werden sie nach ihrem Aktualisierungsdatum sortiert. Wenn mehrere Attribute dasselbe Aktualisierungsdatum aufweisen, werden sie nach der Attribut-ID sortiert. Wird für die API-Paginierung verwendet.

attr_type

string

Default: "client"

Festlegung der Zugriffsebene eines Benutzers für dessen Zugriff auf Dienstattribute.

Enum: "client" "server"

keys

Array of strings <= 5 items

Liste der Attributschlüssel, die Sie abrufen möchten. Wenn Sie nichts angeben, gibt die Methode alle Benutzerattribute zurück.

limit

integer [ 0 .. 20 ]

Default: 20

Anzahl der Benutzer, die bei der Suche anhand von Attributen zurückgegeben wird.

login_project_id

string

Login-ID aus dem Kundenportal-Projekt, dessen Attribute Sie abrufen möchten. Wenn Sie keine ID angeben, werden stattdessen Ihre Händler-ID und die Projekt-ID aus dem Kundenportal verwendet.

publisher_id

integer or null

Ihre Händler-ID, in deren Namen die Anfrage gestellt wird. Erforderlich, um die Anfrage zu autorisieren.

publisher_project_id

integer

ID des Kundenportal-Projekts, dessen Benutzer Sie abrufen möchten. Wenn Sie keine ID angeben, werden Benutzer ohne den Wert dieses Parameters zurückgegeben.

search_type

string

Default: "equal"

Vergleichsbedingung, die die Suchkriterien definiert.

Enum: "equal" "like"

Responses

200

400

Bad Request

403

Forbidden

422

Unprocessable Entity

429

Too Many Requests

Request samples

application/json

{"after": "string",
"attr_type": "client",
"attribute": {"key": "string",
"value": "string"
},
"keys": ["string"
],
"limit": 20,
"login_project_id": "string",
"publisher_id": 0,
"publisher_project_id": 0,
"search_type": "equal"
}

Response samples

application/json

[{"attributes": [{"attr_type": "client",
"data_type": "string",
"description": "string",
"format": "string",
"key": "string",
"permission": "public",
"readonly": true,
"value": "string"
}
],
"email": "string",
"user_id": "string"
}
]