> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ユーザー一覧の取得

> List all human users in the organization. Results are paginated using a cursor.




## OpenAPI

````yaml ja/API/Management-API.yaml GET /users
openapi: 3.1.0
info:
  title: CData Connect AI Management API
  version: v1
  description: >
    The Connect AI Management API provides programmatic control over enterprise
    platform administration. Base path: /api/v1/admin. Use it to manage users,
    service accounts, roles, and resource permissions without manual UI
    operations. The API follows OAS 3.0 standards with OAuth 2.0 scoped
    authentication.

    On versioning: the version prefix is incremented when breaking changes
    require it. A new /api/v2/admin path will be introduced with a 6-month
    deprecation notice before any v1 endpoint is retired.

    On human users vs. service accounts: human users are provisioned and
    lifecycle-managed by SCIM; the Management API handles direct overrides and
    atomic deprovisioning. Service accounts (CI/CD pipelines, IaC tooling,
    Terraform) are fully managed via the Management API and are not SCIM-owned.
servers:
  - url: https://cloud.cdata.com/api/v1/admin
    description: Production base URL
security:
  - oauth2: []
tags:
  - name: Users
    description: >
      Lifecycle management for human users: create, update, deprovision, and
      manage direct role assignments, workspace-scoped roles, and direct
      resource permissions. SCIM handles group-based provisioning and user
      creation at scale; this API handles direct overrides and atomic
      deprovisioning.
  - name: Service Accounts
    description: >
      Full lifecycle management for machine identities (CI/CD pipelines, IaC
      tooling, Terraform automation). Service accounts are not SCIM-owned and
      authenticate via OAuth 2.0 client credentials using the `client_id`
      returned on creation.
paths:
  /users:
    get:
      tags:
        - Users
      summary: List Users
      description: >
        List all human users in the organization. Results are paginated using a
        cursor.
      operationId: listUsers
      parameters:
        - name: status
          in: query
          description: Filter by user status.
          schema:
            type: string
            enum:
              - active
              - invited
              - deactivated
        - name: scim_managed
          in: query
          description: >
            `true` to return only SCIM-provisioned users. `false` to return only
            API-created users. Omit to return all users.
          schema:
            type: boolean
        - name: role_id
          in: query
          description: Filter to users who hold a specific role (direct or group-derived).
          schema:
            type: string
            format: uuid
        - name: email
          in: query
          description: Exact match filter on email address.
          schema:
            type: string
        - name: limit
          in: query
          description: Maximum number of results to return per page.
          schema:
            type: integer
            default: 20
            maximum: 100
        - name: cursor
          in: query
          description: >-
            Pagination cursor from `next_cursor` in the previous response. Omit
            to start from the beginning.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCollection'
              example:
                items:
                  - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    email: jane.doe@example.com
                    first_name: Jane
                    last_name: Doe
                    status: active
                    scim_managed: true
                    external_id: null
                    created_at: '2026-01-15T10:00:00Z'
                    created_by: null
                limit: 20
                next_cursor: null
      security:
        - oauth2:
            - management:users:read
components:
  schemas:
    UserCollection:
      allOf:
        - $ref: '#/components/schemas/CollectionEnvelope'
        - type: object
          properties:
            items:
              type: array
              items:
                $ref: '#/components/schemas/User'
    CollectionEnvelope:
      type: object
      properties:
        limit:
          type: integer
          description: Maximum number of items per page as requested.
        next_cursor:
          type: string
          nullable: true
          description: >-
            Pagination cursor for the next page. null when no further pages
            exist. Total count is not returned.
    User:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: User identifier.
        email:
          type: string
          format: email
          description: The email address of the user.
        first_name:
          type: string
          description: The user's first name.
        last_name:
          type: string
          nullable: true
          description: The user's last name.
        status:
          type: string
          enum:
            - active
            - invited
            - deactivated
          description: Current lifecycle state of the user.
        scim_managed:
          type: boolean
          description: '`false` for API-created users. `true` for SCIM-provisioned users.'
        external_id:
          type: string
          nullable: true
          description: Idempotency key supplied by the calling system.
        created_at:
          type: string
          format: date-time
          description: ISO 8601 UTC.
        created_by:
          type: string
          format: uuid
          nullable: true
          description: User ID of the creator. null for SCIM-provisioned users.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://cloud-login.cdata.com/oauth/token
          scopes:
            management:users:read: Read access to user resources.
            management:users:write: Write access to user resources.
            management:service-accounts:read: Read access to service account resources.
            management:service-accounts:write: Write access to service account resources.

````