Todos os produtos
Search

Este produto

    Qoder CN Series:ListUsers - Listar usuários

    Central de documentação

    Qoder CN Series:ListUsers - Listar usuários

    Última atualização: Jun 29, 2026

    Lista usuários pela OpenAPI.

    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

    Gerenciamento de organização

    Usuário

    Somente leitura

    Sintaxe da requisição

    GET https://{domain}/oapi/v1/platform/users?filter={filter}&status={status}&deptId={deptId}&page={page}&perPage={perPage}

    Detalhes da requisição

    Usuários ativos

    curl -X 'GET' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/users' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

    Usuários excluídos

    curl -X 'GET' \
      'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/platform/users?status=deleted' \
      -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)

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

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

    Parâmetros da requisição

    filter string (Opcional)

    Palavra-chave para busca aproximada por nome de usuário, nome de login, endereço de e-mail ou número de telefone.

    status string (Opcional)

    Filtra usuários por status.

    • enabled: Retorna usuários ativos.

    • deleted: Retorna usuários excluídos.

    deptId string (Opcional)

    Filtra usuários pelo ID do departamento.

    page integer (Opcional) Valor padrão: 1

    Número da página a retornar.

    perPage integer (Opcional) Valor padrão: 100

    Número de entradas a retornar por página. O valor deve estar no intervalo [1, 100].

    Parâmetros de resposta

    Usuários ativos

    [
    {
        "id": "c75d6f21-2af7-4d8e-b0fb-bac25128****",
        "username": "tmp_test2",
        "name": "Test User 2",
        "sysDeptIds": [
            "9e415b19-10bc-4bb6-a34f-2045a59a****"
        ],
        "lastOrganization": "3deba052-8501-4f30-a52d-3e9b1ca8****",
        "createdAt": "2025-06-10T06:45:29Z"
    },
    {
        "id": "85c7aa62-8da7-4f2d-8c99-4b90a253****",
        "username": "tmp_test1",
        "name": "Test User 1",
        "sysDeptIds": [
            "9e415b19-10bc-4bb6-a34f-2045a59a****"
        ],
        "createdAt": "2025-06-10T06:44:57Z"
    }
]

    Usuários excluídos

    [
        {
            "id": "3d4caf00-0004-4a07-9cb7-18c9559d****",
            "username": "doc-test4",
            "name": "Doc Test User 4",
            "nickName": "Nickname 4",
            "email": "doc-test4@example.com",
            "staffId": "1004",
            "sysDeptIds": [
                "ebeb5a64-c98c-478a-9d9d-513841da****"
            ],
            "createdAt": "2025-06-13T05:41:53Z",
            "deletedAt": "2025-06-13T06:36:43Z"
        }
    ]

    id string

    ID exclusivo do usuário.

    username string

    Nome de login do usuário.

    name string

    Nome de exibição do usuário.

    nickName string

    Apelido do usuário.

    email string

    Endereço de e-mail do usuário.

    lastOrganization string

    ID da última organização em que o usuário fez login.

    staffId string

    ID de funcionário do usuário.

    sysDeptIds array[string]

    IDs dos departamentos aos quais o usuário pertence.

    createdAt string

    Data e hora de criação do usuário.

    deletedAt string

    Data e hora de exclusão do usuário.

    Este parâmetro é retornado apenas para usuários excluídos.

    Cabeçalhos de resposta

    Parâmetro

    Descrição

    Valor de exemplo

    x-next-page

    Próxima página

    2

    x-page

    Página atual

    1

    x-per-page

    Número de entradas por página

    100

    x-prev-page

    Página anterior

    0

    x-request-id

    ID da requisição

    37294673-00CA-5B8B-914F-A8B35511E90A

    x-total

    Número total de entradas

    10

    x-total-pages

    Número total de páginas

    1

    Códigos de erro

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