Group User - List

Referência

Serviço:: API Management

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

Lista uma coleção de entidades de usuário associadas ao grupo.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
groupId	path	True	string minLength: 1 maxLength: 256	Identificador de grupo. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
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 uma UUID.
api-version	query	True	string minLength: 1	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 \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| firstName \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| lastName \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| email \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| registrationDate \| filtro \| ge, le, eq, ne, gt, lt \| \| \| observação \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	Número de registros a serem ignoradas.
$top	query		integer (int32) minimum: 1	Número de registros a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	UserCollection	Lista uma coleção de entidades de usuário associadas ao grupo.
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.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementListGroupUsers

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1",
      "type": "Microsoft.ApiManagement/service/groups/users",
      "name": "armTemplateUser1",
      "properties": {
        "firstName": "user1",
        "lastName": "lastname1",
        "email": "user1@live.com",
        "state": "active",
        "registrationDate": "2017-05-31T18:54:41.447Z",
        "note": "note for user 1",
        "identities": [
          {
            "provider": "Basic",
            "id": "user1@live.com"
          }
        ]
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GroupContractProperties	Propriedades do contrato de grupo.
GroupType	Tipo de grupo.
UserCollection	Representação da lista De usuários paginado.
UserContract	Detalhes do usuário.
UserIdentityContract	Detalhes da 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 entrar no portal do desenvolvedor ou chamar nenhuma APIs de produtos assinados. O estado padrão é Ativo.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GroupContractProperties

Objeto

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 maxLength: 1000	Descrição do grupo. Pode conter marcas 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 Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; caso contrário, o valor será nulo.
type	GroupType	Tipo de grupo.

GroupType

Enumeração

Tipo de grupo.

Valor	Description
custom
external
system

UserCollection

Objeto

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

Nome	Tipo	Description
count	integer (int64)	Número total de contagem de registros em todas as páginas.
nextLink	string	Link da próxima página, se houver.
value	UserContract[]	Valores de página.

UserContract

Objeto

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 eletrônico.
properties.firstName	string		Nome próprio.
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		Apelido.
properties.note	string		Observação opcional sobre um usuário definido pelo administrador.
properties.registrationDate	string (date-time)		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 entrar no portal do desenvolvedor ou chamar nenhuma APIs de produtos assinados. O estado padrão é Ativo.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

UserIdentityContract

Objeto

Detalhes da identidade do usuário.

Nome	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 podem entrar no portal do desenvolvedor ou chamar nenhuma APIs de produtos assinados. 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.
deleted	A conta de usuário está fechada. Todas as identidades e entidades relacionadas são removidas.
pending	A conta de usuário está pendente. Requer a confirmação de identidade antes que ela possa se tornar ativa.

Compartilhar via

Group User - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementListGroupUsers

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserCollection

UserContract

UserIdentityContract

UserState

Recursos adicionais