Todos os produtos
Search

Este produto

    Qoder CN Series:Listar membros

    Central de documentação

    Qoder CN Series:Listar membros

    Última atualização: Jun 29, 2026

    Recupera uma lista de membros da organização usando a API.

    Edições compatíveis

    Enterprise Dedicated Edition

    Endpoints de serviço

    Obtenha o endpoint de serviço e substitua {domain} na sintaxe da requisição da API pelo seu endpoint.

    Autorização

    Produto

    Recurso

    Permissão necessária

    organization settings

    membros da organização

    somente leitura

    Sintaxe da requisição

    GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/members

    Requisição

    Consultar a lista de membros

    curl -X 'GET' \
      'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/organizations/99d1****71d4/members?page=1&perPage=100' \
      -H 'Content-Type: application/json' \
      -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

    Cabeçalhos da requisição

    x-yunxiao-token string (Obrigatório)

    O token de acesso. Consulte Token de acesso para obter detalhes.

    Exemplo: pt-0fh3****0fbG_35af****0484.

    Parâmetros da requisição

    organizationId string (Obrigatório)

    O ID da organização. Você encontra este ID na página Basic Information em organization settings.

    page integer (Opcional) Padrão: 1

    Número da página.

    perPage integer (Opcional) Padrão: 100

    Quantidade de entradas retornadas por página. Valores válidos: [1, 100].

    Parâmetros de resposta

    Exemplo de resposta

    [
    {
        "deptIds": ["99d1****6124"],
        "id": "99d1****6124",
        "joined": "2023-08-31T03:59:16.201Z",
        "name": "Example Name",
        "email": "example@example.com",
        "organizationId": "99d1****6124",
        "roleIds": ["99d1****6124"],
        "status": "ENABLED",
        "userId": "99d1****6124",
        "visited": "2023-08-31T03:59:16.201Z"
    }
]

    deptIds array[string]

    IDs dos departamentos aos quais o membro pertence.

    id string

    ID do membro.

    joinedstring

    Timestamp de entrada do membro na organização. Este valor corresponde ao horário de criação do registro no banco de dados.

    name string

    Nome do membro.

    email string

    Endereço de e-mail do membro.

    organizationIdstring

    ID da organização.

    roleIdsarray[string]

    IDs das funções atribuídas ao membro.

    statusstring

    Status do membro.

    Valores válidos: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING e UNVISITED.

    userIdstring

    ID do usuário.

    visitedstring

    Timestamp da última visita do membro.

    Cabeçalhos de resposta

    Parâmetro

    Descrição

    Exemplo

    x-next-page

    Número da próxima página.

    1

    x-page

    Número da página atual.

    2

    x-per-page

    Quantidade de entradas por página.

    1

    x-prev-page

    Número da página anterior.

    2

    x-total

    Número total de entradas.

    1

    x-total-pages

    Número total de páginas.

    3

    Códigos de erro

    Para mais informações, consulte Central de códigos de erro.