User - List By Service

  • Referência
Service:
API Management
API Version:
2022-08-01

Lista uma coleção de usuários registrados na instância de serviço especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?$filter={$filter}&$top={$top}&$skip={$skip}&expandGroups={expandGroups}&api-version=2022-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName
 path True

string

O nome do serviço Gerenciamento de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

A ID da assinatura de destino.
api-version
 query True

string

A versão da API a ser usada para esta operação.
$filter
 query

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| registrationDate | filter | ge, le, eq, ne, gt, lt | |
| observação | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| grupos | expanda | | |
$skip
 query

integer

int32

Número de registros a serem ignorados.
$top
 query

integer

int32

Número de registros a serem retornados.
expandGroups
 query

boolean

Grupo Detalhado em resposta.

Respostas

Nome Tipo Description
200 OK

UserCollection

Lista uma coleção de entidades de usuário.
Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementListUsers

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "1",
      "properties": {
        "firstName": "Administrator",
        "lastName": "",
        "email": "admin@live.com",
        "state": "active",
        "registrationDate": "2015-09-22T01:57:39.677Z",
        "identities": [
          {
            "provider": "Azure",
            "id": "admin@live.com"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "56eaec62baf08b06e46d27fd",
      "properties": {
        "firstName": "foo",
        "lastName": "bar",
        "email": "foo.bar.83@gmail.com",
        "state": "active",
        "registrationDate": "2016-03-17T17:41:56.327Z",
        "identities": [
          {
            "provider": "Basic",
            "id": "foo.bar.83@gmail.com"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/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": "*************"
          }
        ]
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definições

Nome Description
ErrorFieldContract

Contrato de campo de erro.
ErrorResponse

Resposta de erro.
GroupContractProperties

Propriedades do contrato de grupo.
GroupType

Tipo de grupo.
UserCollection

Representação de lista De usuários paginado.
UserContract

Detalhes do usuário.
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 podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

ErrorFieldContract

Contrato de campo de erro.

Nome Tipo Description
code

string

Código de erro no nível da propriedade.
message

string

Representação legível por humanos do erro no nível da propriedade.
target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error.code

string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details

ErrorFieldContract[]

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message

string

Representação legível ao olho humano do erro.

GroupContractProperties

Propriedades do contrato de grupo.

Nome Tipo Description
builtIn

boolean

true se o grupo for um dos três grupos do sistema (Administradores, Desenvolvedores ou Convidados); caso contrário, false.
description

string

Descrição do grupo. Pode conter marcas de formatação HTML.
displayName

string

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 Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.
type

GroupType

Tipo de grupo.

GroupType

Tipo de grupo.

Nome Tipo Description
custom

string

external

string

system

string

UserCollection

Representação de lista De usuários paginado.

Nome Tipo Description
count

integer

Número total de contagem de registros em todas as páginas.
nextLink

string

Próximo link da página, se houver.
value

UserContract[]

Valores de página.

UserContract

Detalhes do usuário.

Nome Tipo Valor padrão Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.email

string

Endereço de email.
properties.firstName

string

Nome.
properties.groups

GroupContractProperties[]

A coleção de grupos do qual o usuário faz parte.
properties.identities

UserIdentityContract[]

Coleção de identidades de usuário.
properties.lastName

string

Sobrenome.
properties.note

string

Observação opcional sobre um usuário definido pelo administrador.
properties.registrationDate

string

Data do registro do usuário. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão 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 podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.
type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

UserIdentityContract

Detalhes de identidade do usuário.

Nome Tipo Description
id

string

Valor do identificador dentro do provedor.
provider

string

Nome do provedor de identidade.

UserState

Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

Nome Tipo Description
active

string

O estado do usuário está ativo.
blocked

string

O usuário está bloqueado. Os usuários bloqueados não podem se autenticar no portal do desenvolvedor ou chamar a API.
deleted

string

A conta de usuário está fechada. Todas as identidades e entidades relacionadas são removidas.
pending

string

A conta de usuário está pendente. Requer confirmação de identidade antes que ela possa ser ativada.