Manage account profiles - Add new user member to role
Adds a new user member to the specified role.
POST https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembersURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
role_id
|
path | True |
string |
The role identifier. |
|
version
|
path | True |
string |
Api version. |
Request Header
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "text/json"
| Name | Required | Type | Description |
|---|---|---|---|
| Authorization | True |
string |
Authorization Bearer token |
| Accept | True |
string |
Acceptable content type; widely accepeted type application/json |
| ms-correlationid |
string |
Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request |
|
| ms-requestid |
string |
Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request |
Request Body
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "text/json"
| Name | Type | Description |
|---|---|---|
| accountId |
string |
Gets or sets the account id where role assignment is tied. |
| displayName |
string |
Gets or sets the display name for the user. |
| id |
string |
The identifier of the member. |
| roleId |
string |
The identifier of the user's role. |
| userPrincipalName |
string |
Gets or sets the name of the user principal. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
object |
OK Media Types: "application/json", "application/xml", "text/xml", "text/json" |
| 201 Created |
Microsoft. |
OK Media Types: "application/json", "application/xml", "text/xml", "text/json" |
| 400 Bad Request |
There was a missing or an invalid input. The response body will provide the error details. Media Types: "application/json", "application/xml", "text/xml", "text/json" |
|
| 401 Unauthorized |
The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "application/xml", "text/xml", "text/json" |
|
| 403 Forbidden |
The request was authenticated but was refused since the caller does not have the rights to invoke it. Media Types: "application/json", "application/xml", "text/xml", "text/json" |
|
| 404 Not Found |
The resource is not found or not available with the given input parameters. Media Types: "application/json", "application/xml", "text/xml", "text/json" |
|
| 500 Internal Server Error |
The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this. Media Types: "application/json", "application/xml", "text/xml", "text/json" |
Definitions
| Name | Description |
|---|---|
|
Microsoft. |
Refers to the common object attributes |
|
Microsoft. |
Describes a user's member information. |
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes
Refers to the common object attributes
| Name | Type | Description |
|---|---|---|
| etag |
string |
Gets or sets the etag. The object version in providers. |
| objectType |
string |
The type of object. |
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember
Describes a user's member information.
| Name | Type | Description |
|---|---|---|
| accountId |
string |
Gets or sets the account id where role assignment is tied. |
| attributes |
Microsoft. |
Gets the attributes. |
| displayName |
string |
Gets or sets the display name for the user. |
| id |
string |
The identifier of the member. |
| roleId |
string |
The identifier of the user's role. |
| userPrincipalName |
string |
Gets or sets the name of the user principal. |