Kiteworks scim API

The scim API from Kiteworks — 9 operation(s) for scim.

OpenAPI Specification

kiteworks-scim-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  version: '28'
  title: Kiteworks API Documentation activities scim API
tags:
- name: scim
paths:
  /rest/scim/users:
    post:
      summary: Create a user
      description: "### Description:\n  Creates a new SCIM user with the specified attributes.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  The newly created user is returned.\n"
      tags:
      - scim
      parameters:
      - in: query
        name: attributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to include in the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:id
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      - in: query
        name: excludedAttributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to exclude from the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimUsersPostRequest'
      responses:
        '201':
          description: The user is created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '409':
          description: Conflict.
        '490':
          description: Request blocked by WAF
    get:
      summary: Retrieve users
      description: "### Description:\n  Returns a paginated list of SCIM users matching the specified filter criteria.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  A list of SCIM users is returned.\n"
      tags:
      - scim
      parameters:
      - in: query
        name: attributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to include in the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:id
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      - in: query
        name: excludedAttributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to exclude from the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      - in: query
        name: filter
        required: false
        description: SCIM filter expression to narrow the list of returned users (e.g., `userName eq "user@example.com"`).
        schema:
          type: string
      - in: query
        name: sortBy
        required: false
        description: Attribute name to sort results by.
        schema:
          type: string
          enum:
          - meta.created
          - meta.location
          - userName
          - displayName
          - userType
          - preferredLanguage
          - emails
          - emails.value
          - phoneNumbers
          - phoneNumbers.value
          - roles
          - roles.value
          - active
          - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
          - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
          - urn:ietf:params:scim:schemas:core:2.0:User:userName
          - urn:ietf:params:scim:schemas:core:2.0:User:displayName
          - urn:ietf:params:scim:schemas:core:2.0:User:userType
          - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
          - urn:ietf:params:scim:schemas:core:2.0:User:emails
          - urn:ietf:params:scim:schemas:core:2.0:User:emails.value
          - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
          - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers.value
          - urn:ietf:params:scim:schemas:core:2.0:User:roles
          - urn:ietf:params:scim:schemas:core:2.0:User:roles.value
          - urn:ietf:params:scim:schemas:core:2.0:User:active
      - in: query
        name: sortOrder
        required: false
        description: Sort direction for the results.<br>`ascending` – Sort in ascending order.<br>`descending` – Sort in descending order.
        schema:
          type: string
          enum:
          - ascending
          - descending
      - in: query
        name: startIndex
        required: false
        description: 1-based index of the first result to return, used for pagination.
        schema:
          type: integer
      - in: query
        name: count
        required: false
        description: 'Maximum number of results to return per page (maximum: 1,000,000).'
        schema:
          type: integer
          maximum: 1000000
      responses:
        '200':
          description: The users are returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUsers'
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '490':
          description: Request blocked by WAF
  /rest/scim/Users:
    post:
      summary: Create a user
      description: "### Description:\n  Creates a new SCIM user with the specified attributes.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  The newly created user is returned.\n"
      tags:
      - scim
      parameters:
      - in: query
        name: attributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to include in the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:id
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      - in: query
        name: excludedAttributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to exclude from the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimUsersPostRequest'
      responses:
        '201':
          description: The user is created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '409':
          description: Conflict.
        '490':
          description: Request blocked by WAF
    get:
      summary: Retrieve users
      description: "### Description:\n  Returns a paginated list of SCIM users matching the specified filter criteria.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  A list of SCIM users is returned.\n"
      tags:
      - scim
      parameters:
      - in: query
        name: attributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to include in the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:id
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      - in: query
        name: excludedAttributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to exclude from the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      - in: query
        name: filter
        required: false
        description: SCIM filter expression to narrow the list of returned users (e.g., `userName eq "user@example.com"`).
        schema:
          type: string
      - in: query
        name: sortBy
        required: false
        description: Attribute name to sort results by.
        schema:
          type: string
          enum:
          - meta.created
          - meta.location
          - userName
          - displayName
          - userType
          - preferredLanguage
          - emails
          - emails.value
          - phoneNumbers
          - phoneNumbers.value
          - roles
          - roles.value
          - active
          - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
          - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
          - urn:ietf:params:scim:schemas:core:2.0:User:userName
          - urn:ietf:params:scim:schemas:core:2.0:User:displayName
          - urn:ietf:params:scim:schemas:core:2.0:User:userType
          - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
          - urn:ietf:params:scim:schemas:core:2.0:User:emails
          - urn:ietf:params:scim:schemas:core:2.0:User:emails.value
          - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
          - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers.value
          - urn:ietf:params:scim:schemas:core:2.0:User:roles
          - urn:ietf:params:scim:schemas:core:2.0:User:roles.value
          - urn:ietf:params:scim:schemas:core:2.0:User:active
      - in: query
        name: sortOrder
        required: false
        description: Sort direction for the results.<br>`ascending` – Sort in ascending order.<br>`descending` – Sort in descending order.
        schema:
          type: string
          enum:
          - ascending
          - descending
      - in: query
        name: startIndex
        required: false
        description: 1-based index of the first result to return, used for pagination.
        schema:
          type: integer
      - in: query
        name: count
        required: false
        description: 'Maximum number of results to return per page (maximum: 1,000,000).'
        schema:
          type: integer
          maximum: 1000000
      responses:
        '200':
          description: The users are returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUsers'
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '490':
          description: Request blocked by WAF
  /rest/scim/users/{id}:
    put:
      summary: Update a user
      description: "### Description:\n  Updates the SCIM user corresponding to the provided ID.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  The updated user is returned.\n"
      tags:
      - scim
      parameters:
      - in: path
        name: id
        required: true
        description: The unique identifier (UUID) of the entity.
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimUsersPutRequest'
      responses:
        '200':
          description: The user is updated and returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '401':
          description: 'ERR_AUTH_INVALID_CSRF


            ERR_AUTH_UNAUTHORIZED

            '
        '404':
          description: ERR_ENTITY_NOT_FOUND
        '490':
          description: Request blocked by WAF
    get:
      summary: Return a user
      description: "### Description:\n  Returns the SCIM user corresponding to the provided ID.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  The user is returned.\n"
      tags:
      - scim
      parameters:
      - in: path
        name: id
        required: true
        description: The unique identifier (UUID) of the entity.
        schema:
          type: string
          format: uuid
      - in: query
        name: attributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to include in the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:id
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      - in: query
        name: excludedAttributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to exclude from the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      responses:
        '200':
          description: The user is returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '490':
          description: Request blocked by WAF
    delete:
      summary: Delete a user
      description: "### Description:\n  Deletes the SCIM user corresponding to the provided ID.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  The user is deleted.\n"
      tags:
      - scim
      parameters:
      - in: path
        name: id
        required: true
        description: The unique identifier (UUID) of the entity.
        schema:
          type: string
          format: uuid
      - in: query
        name: remoteWipe
        required: false
        description: If true, triggers a remote wipe of the user data from all registered devices.
        schema:
          type: boolean
          default: false
      - in: query
        name: deleteUnsharedData
        required: false
        description: If true, permanently deletes data that is not shared with other users.
        schema:
          type: boolean
          default: null
          nullable: true
      - in: query
        name: retainData
        required: false
        description: If true, retains the user data after deletion.
        schema:
          type: boolean
          default: null
          nullable: true
      - in: query
        name: retainPermissionToSharedData
        required: false
        description: If true, the specified `retainToUser` will retain access to shared data.
        schema:
          type: boolean
          default: false
      - in: query
        name: retainToUser
        required: false
        description: UUID of the user who will receive ownership of the deleted user data.
        schema:
          type: string
          default: false
      responses:
        '204':
          description: The user is deleted successfully.
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '490':
          description: Request blocked by WAF
  /rest/scim/Users/{id}:
    put:
      summary: Update a user
      description: "### Description:\n  Updates the SCIM user corresponding to the provided ID.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  The updated user is returned.\n"
      tags:
      - scim
      parameters:
      - in: path
        name: id
        required: true
        description: The unique identifier (UUID) of the entity.
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScimUsersPutRequest'
      responses:
        '200':
          description: The user is updated and returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '401':
          description: 'ERR_AUTH_INVALID_CSRF


            ERR_AUTH_UNAUTHORIZED

            '
        '404':
          description: ERR_ENTITY_NOT_FOUND
        '490':
          description: Request blocked by WAF
    get:
      summary: Return a user
      description: "### Description:\n  Returns the SCIM user corresponding to the provided ID.\n### Precondition:\n  The request must be authenticated using a valid SCIM token.\n### Response:\n  The user is returned.\n"
      tags:
      - scim
      parameters:
      - in: path
        name: id
        required: true
        description: The unique identifier (UUID) of the entity.
        schema:
          type: string
          format: uuid
      - in: query
        name: attributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to include in the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - id
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:id
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      - in: query
        name: excludedAttributes
        required: false
        explode: true
        style: form
        description: Comma-separated list of attribute names to exclude from the response.
        schema:
          type: array
          items:
            type: string
            enum:
            - meta
            - userName
            - displayName
            - userType
            - preferredLanguage
            - active
            - emails
            - phoneNumbers
            - photos
            - roles
            - meta.resourceType
            - meta.created
            - meta.location
            - urn:ietf:params:scim:schemas:core:2.0:User:meta
            - urn:ietf:params:scim:schemas:core:2.0:User:userName
            - urn:ietf:params:scim:schemas:core:2.0:User:displayName
            - urn:ietf:params:scim:schemas:core:2.0:User:userType
            - urn:ietf:params:scim:schemas:core:2.0:User:preferredLanguage
            - urn:ietf:params:scim:schemas:core:2.0:User:active
            - urn:ietf:params:scim:schemas:core:2.0:User:emails
            - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers
            - urn:ietf:params:scim:schemas:core:2.0:User:photos
            - urn:ietf:params:scim:schemas:core:2.0:User:roles
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.resourceType
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.created
            - urn:ietf:params:scim:schemas:core:2.0:User:meta.location
      responses:
        '200':
          description: The user is returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUser'
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
        '490':
          description: Request blocked by WAF
    delete:
      summary: Delete a user
      description: "### Description:\n  Deletes th

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kiteworks/refs/heads/main/openapi/kiteworks-scim-api-openapi.yml