Retrieve a Reseller mpn profile

GET /v1/Resellers/mpn-profile

Gets the mpn profile for a microsoft reseller based on its mpn id. This request is only valid when using a Microsoft tenant/provider. Available to the roles: csp

Headers

X-Tenant string Required

This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.
Authorization string Required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Default value is Bearer eyJ0eXAiO....
X-Correlation-Id string(UUID)

This header is optional and by setting it you can correlate the audit logs made by this request.

Query parameters

tenantId string Required

The Microsoft tenant identifier to use in request to Microsoft.
mpnId string Required

The mpn id of the reseller.

Responses

200

text/plain

text/plain application/json text/json

Success
Hide response attributes Show response attributes object
- mpnId string | null
  
  The mpn id of the partner. Can be null if an error occurred retrieving the profile.
- partnerName string | null
  
  The name of the partner associated to the mpn id. Can be null if an error occurred retrieving the profile.
- errorCode string | null
  
  An error code received from partner center APIs.
- errorMessage string | null
  
  An error message received from partner center APIs.
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- mpnId string | null
  
  The mpn id of the partner. Can be null if an error occurred retrieving the profile.
- partnerName string | null
  
  The name of the partner associated to the mpn id. Can be null if an error occurred retrieving the profile.
- errorCode string | null
  
  An error code received from partner center APIs.
- errorMessage string | null
  
  An error message received from partner center APIs.
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- mpnId string | null
  
  The mpn id of the partner. Can be null if an error occurred retrieving the profile.
- partnerName string | null
  
  The name of the partner associated to the mpn id. Can be null if an error occurred retrieving the profile.
- errorCode string | null
  
  An error code received from partner center APIs.
- errorMessage string | null
  
  An error message received from partner center APIs.
- Additional properties are NOT allowed
400

text/plain

text/plain application/json text/json

Bad Request
Hide response attributes Show response attributes object
This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
401

Unauthorized
403

Forbidden
500

text/plain

text/plain application/json text/json

Server Error
Hide response attributes Show response attributes object
This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
This class represents the response which is returned to consumers in case of an error, containing details about it, as well as the correlationId of the performed request so that consumers can supply us that id for us to provide support.
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

GET /v1/Resellers/mpn-profile

curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Resellers/mpn-profile?tenantId=string&mpnId=string \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"

Response examples (200)

{
  "mpnId": "string",
  "partnerName": "string",
  "errorCode": "string",
  "errorMessage": "string"
}

Response examples (200)

{
  "mpnId": "string",
  "partnerName": "string",
  "errorCode": "string",
  "errorMessage": "string"
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}