Compartilhar via


Manage account profiles - Get organization profile

Obtém o perfil da organização.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
version
path True

string

Versão da API.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Token de portador de autorização

Accept True

string

Tipo de conteúdo aceitável; aplicativo/json de tipo amplamente accepeted

ms-correlationid

string

Usado para acompanhar solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação

ms-requestid

string

Usado para idempotency de solicitações. Se uma ms-requestid não for fornecida, o servidor gerará uma nova para cada solicitação

Respostas

Nome Tipo Description
200 OK

Microsoft.Partner.Sdk.Contracts.V1.OrganizationProfile

A solicitação foi bem-sucedida. O corpo da resposta contém o perfil da organização.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

400 Bad Request

Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

401 Unauthorized

A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

403 Forbidden

A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

404 Not Found

O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

500 Internal Server Error

O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem repetir isso.

Media Types: "application/json", "application/xml", "text/xml", "text/json"

Definições

Nome Description
Microsoft.Partner.Sdk.Contracts.V1.Address

Representa um endereço para um cliente ou parceiro.

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

O link representa um URI e o método HTTP que indica a ação desejada para acessar o recurso.

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

Refere-se aos atributos de objeto comuns

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks

Links de navegação para o recurso

Microsoft.Partner.Sdk.Contracts.V1.OrganizationProfile

Descreve o perfil da organização de um parceiro.

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

Microsoft.Partner.Sdk.Contracts.V1.Address

Representa um endereço para um cliente ou parceiro.

Nome Tipo Description
addressLine1

string

Obtém ou define a primeira linha do endereço.

addressLine2

string

Obtém ou define a segunda linha do endereço. Essa propriedade é opcional.

city

string

Obtém ou define a cidade.

country

string

Obtém ou define o país/região no formato de código de país ISO.

firstName

string

Obtém ou define o nome de um contato na empresa/organização do cliente.

lastName

string

Obtém ou define o sobrenome de um contato na empresa/organização do cliente.

phoneNumber

string

Obtém ou define o número de telefone de um contato na empresa/organização do cliente. Essa propriedade é opcional.

postalCode

string

Obtém ou define o CEP ou código postal.

region

string

Obtém ou define a região.

state

string

Obtém ou define o estado.

O link representa um URI e o método HTTP que indica a ação desejada para acessar o recurso.

Nome Tipo Description
headers

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

Obtém os cabeçalhos de link.

method

string

O método.

uri

string

O URI.

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

Refere-se aos atributos de objeto comuns

Nome Tipo Description
etag

string

Obtém ou define a etag. A versão do objeto em provedores.

objectType

string

O tipo de objeto.

Links de navegação para o recurso

Nome Tipo Description
next

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

A próxima página de itens.

previous

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

A página anterior dos itens.

self

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

O auto-uri.

Microsoft.Partner.Sdk.Contracts.V1.OrganizationProfile

Descreve o perfil da organização de um parceiro.

Nome Tipo Description
attributes

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

Obtém os atributos.

companyName

string

GEts ou define o nome da empresa ou organização.

culture

string

Obtém ou define a cultura preferencial para comunicação e moeda, como "en-us".

defaultAddress

Microsoft.Partner.Sdk.Contracts.V1.Address

Obtém ou define o endereço padrão da empresa ou organização.

domain

string

Obtém ou define o domínio da empresa ou da organização.

email

string

Obtém ou define o email da empresa ou da organização

id

string

Obtém ou define o identificador da organização.

language

string

Obtém ou define o idioma preferencial para comunicação.

links

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks

Obtém ou define os links.

profileType enum:
  • billing_profile
  • legal_business_profile
  • mpn_profile
  • organization_profile
  • support_profile

Obtém o tipo de perfil de parceiro.

tenantId

string

Obtém ou define o identificador de locatário.

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

Nome Tipo Description
key

string

value

string