Manage account profiles - Get all available roles

Service:

Partner Center Rest

API Version:

v1

Gets all the roles available.

GET https://api.partnercenter.microsoft.com/v{version}/roles

URI Parameters

Name	In	Required	Type	Description
version	path	True	string	Api version.

Request Header

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

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.Role]	The request was successful. The response body contains the list of supported roles. Media Types: "application/json", "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", "text/json"
401 Unauthorized		The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "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", "text/json"
404 Not Found		The resource is not found or not available with the given input parameters. Media Types: "application/json", "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", "text/json"

Definitions

Name	Description
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.Role]	Contains a collection of resources with JSON properties to represent the output
Microsoft.Partner.Sdk.Contracts.V1.Common.Link	Link represents a URI and the HTTP method which indicates the desired action for accessing the resource.
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Refers to the common object attributes
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	Navigation links for the resource
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.Role	Represents a role object used as a contract for role operations.
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.Role]

Contains a collection of resources with JSON properties to represent the output

Name	Type	Description
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Gets the attributes.
items	Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.Role[]	Gets the collection items.
links	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	Gets or sets the links.
totalCount	integer	Gets the total count.

Microsoft.Partner.Sdk.Contracts.V1.Common.Link

Link represents a URI and the HTTP method which indicates the desired action for accessing the resource.

Name	Type	Description
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]	Gets the link headers.
method	string	The method.
uri	string	The URI.

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.Common.ResourceLinks

Navigation links for the resource

Name	Type	Description
next	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	The next page of items.
previous	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	The previous page of items.
self	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	The self uri.

Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.Role

Represents a role object used as a contract for role operations.

Name	Type	Description
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	Gets the attributes.
category	enum: account_admin developer incentive marketing mpn partner_agent publisher referrals tenant	Gets or sets the category of the role.
id	string	Gets or sets the id of the role.
links	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	Gets or sets the links.
name	string	Gets or sets the name of the role.

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name	Type	Description
key	string
value	string