서버에서 특성별로 사용자 가져오기

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

특성은 사용자 목록을 가져오는 데 사용됩니다.

key required	string <= 256 characters [A-Za-z0-9_]+ 사용자의 특성을 식별하는 데 사용하는 특성의 이름입니다. 사용자별로 고유해야 합니다.
value	string or null 사용자의 특성 값입니다. 이 값이 있는 `key` 매개변수를 가진 사용자를 가져오는 데 필요합니다. 지정하지 않으면 이 키에 대한 값을 가진 모든 사용자를 반환합니다.

after

string or null

keys 목록에 있는 최신 특성의 사용자 특성 및 ID의 업데이트 날짜입니다. 처음에는 설정하지 않아야 합니다. 특성별로 사용자를 가져오면 사용자가 업데이트 날짜별로 정렬됩니다. 여러 특성의 업데이트 날짜가 같은 경우 특성 ID별로 정렬됩니다. API 페이지 매김에 사용됩니다.

attr_type

string

Default: "client"

서비스 특성에 대한 사용자의 액세스 수준 정의입니다.

Enum: "client" "server"

keys

Array of strings <= 5 items

얻고자 하는 특성의 키 목록입니다. 지정하지 않으면 메소드가 모든 사용자의 특성을 반환합니다.

limit

integer [ 0 .. 20 ]

Default: 20

특성별로 검색할 때 반환되는 사용자 수입니다.

login_project_id

string

사용자의 특성을 가져오려고 하는 게시자 계정의 로그인 ID입니다. 지정한 경우 게시자 계정의 판매자 ID 및 프로젝트 ID를 대신 사용합니다.

publisher_id

integer or null

요청의 대상이 되는 판매자 ID입니다. 요청 인증에 필요합니다.

publisher_project_id

integer

사용자를 가져오려고 하는 게시자 계정의 프로젝트 ID입니다. 지정하지 않으면 이 매개변수 값이 없는 사용자를 반환합니다.

search_type

string

Default: "equal"

검색 기준을 정의하는 비교 조건입니다.

Enum: "equal" "like"

Responses

200

확인

400

잘못된 요청

403

금지됨

422

처리할 수 없는 엔터티

429

요청이 너무 많음

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