Manage account profiles - Get user members by role
특정 크기로 제한되는 역할의 사용자 멤버 세그먼트를 가져옵니다.
GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembersGET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers?size={size}&sortField={sortField}&sortDirection={sortDirection}&seekOperation={seekOperation}URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
role_id
|
path | True |
string |
역할 식별자입니다. |
|
version
|
path | True |
string |
Api 버전입니다. |
|
seek
|
query |
string |
역할의 사용자 멤버에 대해 수행할 검색 작업입니다. 이는 사용자 멤버의 다음 또는 이전 페이지가 필요한 페이징 시나리오에서 유용합니다. |
|
|
size
|
query |
integer int32 |
반환할 최대 사용자 멤버 수, 값이 500을 초과하면 안 되며 1보다 작지 않아야 합니다. |
|
|
sort
|
query |
string |
정렬 기준 방향에 대한 선택적 정렬 매개 변수이고, 허용되는 값은 오름차순 및 내림차순이고, 기본값은 오름차순입니다. |
|
|
sort
|
query |
string |
정렬 기준 필드의 선택적 정렬 매개 변수이며 허용되는 값은 DisplayName 및 UserPrincipalName이며, 기본값은 UserPrincipalName입니다. |
요청 헤더
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| Authorization | True |
string |
권한 부여 전달자 토큰 |
| Accept | True |
string |
허용 가능한 콘텐츠 형식; 널리 적응된 형식 애플리케이션/json |
| ms-correlationid |
string |
내부적으로 요청을 추적하는 데 사용됩니다. ms-correlationid가 제공되지 않으면 서버는 각 요청에 대해 새 상관 관계를 생성합니다. |
|
| ms-requestid |
string |
요청의 idempotency에 사용됩니다. ms-requestid가 제공되지 않으면 서버는 각 요청에 대해 새 요청을 생성합니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
요청이 성공했습니다. 응답 본문에는 사용자 멤버 목록이 포함됩니다. Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
누락되었거나 잘못된 입력이 있었습니다. 응답 본문은 오류 세부 정보를 제공합니다. Media Types: "application/json", "text/json" |
|
| 401 Unauthorized |
요청이 인증되지 않았습니다. 클라이언트는 먼저 파트너 API 서비스를 사용하여 인증해야 합니다. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
요청이 인증되었지만 호출자가 호출할 권한이 없으므로 거부되었습니다. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
리소스를 찾을 수 없거나 지정된 입력 매개 변수와 함께 사용할 수 없습니다. Media Types: "application/json", "text/json" |
|
| 500 Internal Server Error |
파트너 API 서비스 또는 해당 종속성 중 하나가 요청을 충족하지 못했습니다. 호출자는 이를 다시 시도할 수 있습니다. Media Types: "application/json", "text/json" |
정의
| Name | Description |
|---|---|
|
Microsoft. |
출력을 나타내는 JSON 속성이 있는 리소스 컬렉션을 포함합니다. |
|
Microsoft. |
링크는 리소스에 액세스하기 위한 원하는 작업을 나타내는 URI 및 HTTP 메서드를 나타냅니다. |
|
Microsoft. |
일반적인 개체 특성을 참조합니다. |
|
Microsoft. |
리소스에 대한 탐색 링크 |
|
Microsoft. |
사용자의 멤버 정보를 설명합니다. |
|
System. |
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]
출력을 나타내는 JSON 속성이 있는 리소스 컬렉션을 포함합니다.
| Name | 형식 | Description |
|---|---|---|
| attributes |
Microsoft. |
특성을 가져옵니다. |
| items |
Microsoft. |
컬렉션 항목을 가져옵니다. |
| links |
링크를 가져오거나 설정합니다. |
|
| totalCount |
integer |
총 개수를 가져옵니다. |
Microsoft.Partner.Sdk.Contracts.V1.Common.Link
링크는 리소스에 액세스하기 위한 원하는 작업을 나타내는 URI 및 HTTP 메서드를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| headers |
System. |
링크 헤더를 가져옵니다. |
| method |
string |
메서드입니다. |
| uri |
string |
URI입니다. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
일반적인 개체 특성을 참조합니다.
| Name | 형식 | Description |
|---|---|---|
| etag |
string |
etag를 가져오거나 설정합니다. 공급자의 개체 버전입니다. |
| objectType |
string |
개체의 형식입니다. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks
리소스에 대한 탐색 링크
| Name | 형식 | Description |
|---|---|---|
| next |
항목의 다음 페이지입니다. |
|
| previous |
항목의 이전 페이지입니다. |
|
| self |
자체 URI입니다. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
사용자의 멤버 정보를 설명합니다.
| Name | 형식 | Description |
|---|---|---|
| accountId |
string |
역할 할당이 연결된 계정 ID를 가져오거나 설정합니다. |
| attributes |
Microsoft. |
특성을 가져옵니다. |
| displayName |
string |
사용자의 표시 이름을 가져오거나 설정합니다. |
| id |
string |
멤버의 식별자입니다. |
| roleId |
string |
사용자 역할의 식별자입니다. |
| userPrincipalName |
string |
사용자 보안 주체의 이름을 가져오거나 설정합니다. |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | 형식 | Description |
|---|---|---|
| key |
string |
|
| value |
string |