User - Get

Serviço:: API Management

Versão da API:: 2024-05-01

Obtém os detalhes do usuário especificado por seu identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2024-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
userId	path	True	string minLength: 1 maxLength: 80	Identificador do utilizador. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	UserContract	Obtém a entidade de usuário especificada. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

UserContract

Obtém a entidade de usuário especificada.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementGetUser

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b?api-version=2024-05-01

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2017-06-02T17:58:50.357Z",
    "identities": [
      {
        "provider": "Microsoft",
        "id": "*************"
      }
    ]
  }
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GroupContractProperties	Propriedade do contrato de grupo.
GroupType	Tipo de grupo.
UserContract	Dados do utilizador.
UserIdentityContract	Detalhes de identidade do usuário.
UserState	Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não conseguem entrar no portal do desenvolvedor ou chamar quaisquer APIs de produtos inscritos. O estado padrão é Ativo.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GroupContractProperties

Object

Propriedade do contrato de grupo.

Name	Tipo	Description
builtIn	boolean	true se o grupo for um dos três grupos do sistema (Administradores, Desenvolvedores ou Convidados); caso contrário, falso.
description	string maxLength: 1000	Descrição do grupo. Pode conter tags de formatação HTML.
displayName	string minLength: 1 maxLength: 300	Nome do grupo.
externalId	string	Para grupos externos, essa propriedade contém a id do grupo do provedor de identidade externo, por exemplo, para o Azure Ative Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; caso contrário, o valor é null.
type	GroupType	Tipo de grupo.

GroupType

Enumeração

Tipo de grupo.

Valor	Description
custom
system
external

UserContract

Object

Dados do utilizador.

Name	Tipo	Default value	Description
id	string		ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		O nome do recurso
properties.email	string		Endereço de e-mail.
properties.firstName	string		Nome próprio.
properties.groups	GroupContractProperties[]		Coleção de grupos do qual o usuário faz parte.
properties.identities	UserIdentityContract[]		Coleção de identidades de usuário.
properties.lastName	string		Apelido.
properties.note	string		Observação opcional sobre um usuário definida pelo administrador.
properties.registrationDate	string (date-time)		Data de registo do utilizador. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
properties.state	UserState	active	Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não conseguem entrar no portal do desenvolvedor ou chamar quaisquer APIs de produtos inscritos. O estado padrão é Ativo.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

UserIdentityContract

Object

Detalhes de identidade do usuário.

Name	Tipo	Description
id	string	Valor do identificador dentro do provedor.
provider	string	Nome do provedor de identidade.

UserState

Enumeração

Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não conseguem entrar no portal do desenvolvedor ou chamar quaisquer APIs de produtos inscritos. O estado padrão é Ativo.

Valor	Description
active	O estado do usuário está ativo.
blocked	O usuário está bloqueado. Os usuários bloqueados não podem se autenticar no portal do desenvolvedor ou chamar a API.
pending	A conta de utilizador está pendente. Requer confirmação de identidade antes de poder ser ativado.
deleted	A conta de utilizador está fechada. Todas as identidades e entidades relacionadas são removidas.

Partilhar via

User - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementGetUser

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserIdentityContract

UserState