x-generator: NSwag v13.18.2.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v11.0.0.0))
swagger: '2.0'
info:
  title: Absorb SCIM API
  version: v2
consumes:
  - application/json
produces:
  - application/json
paths:
  /scim/v2/Schemas:
    get:
      tags:
        - Schemas
      summary: List Schemas.
      operationId: Schemas_GetSchemas
      responses:
        '200':
          x-nullable: false
          description: ''
          schema:
            $ref: '#/definitions/ListResponseOfSchemaResponse'
        '400':
          x-nullable: false
          description: ''
          schema:
            $ref: '#/definitions/ErrorResponse'
        '403':
          x-nullable: false
          description: The filter query string is not allowed.
          schema:
            $ref: '#/definitions/ErrorResponse'
  /scim/v2/Schemas/{schemaId}:
    get:
      tags:
        - Schemas
      summary: Get schema by schema URN.
      operationId: Schemas_GetSchema
      parameters:
        - type: string
          name: schemaId
          in: path
          required: true
          description: Schema's URN
          x-nullable: false
        - type: array
          name: attributes
          in: query
          description: The list of attributes to include in the response.
          collectionFormat: multi
          x-nullable: true
          items:
            type: string
        - type: array
          name: excludedAttributes
          in: query
          description: The list of attributes to exclude from the response.
          collectionFormat: multi
          x-nullable: true
          items:
            type: string
      responses:
        '200':
          x-nullable: false
          description: ''
          schema:
            $ref: '#/definitions/SchemaResponse'
        '400':
          x-nullable: false
          description: ''
          schema:
            $ref: '#/definitions/ErrorResponse'
        '404':
          x-nullable: false
          description: Schema ID is not found.
          schema:
            $ref: '#/definitions/ErrorResponse'
definitions:
  ListResponseOfSchemaResponse:
    type: object
    description: The SCIM response for paginated list requests.
    properties:
      schemas:
        type: array
        description: The response schemas.
        items:
          type: string
      totalResults:
        type: integer
        description: The total number of results returned.
        format: int32
      startIndex:
        type: integer
        description: >-
          The 1-based index of the first result in the current set of search
          results.
        format: int32
      itemsPerPage:
        type: integer
        description: The number of results returned on a page.
        format: int32
      Resources:
        type: array
        description: The list of returned resources.
        items:
          $ref: '#/definitions/SchemaResponse'
  SchemaResponse:
    type: object
    description: Resource for a schema.
    properties:
      schemas:
        type: array
        description: The Schemas.
        items:
          type: string
      id:
        type: string
        description: The unique URI of the schema.
      name:
        type: string
        description: The schema's human-readable name.
      description:
        type: string
        description: The schema's human-readable description.
      attributes:
        type: array
        description: >-
          An array of attributes that define service provider attributes and
          their qualities.
        items:
          $ref: '#/definitions/SchemaPropertyResponse'
  SchemaPropertyResponse:
    type: object
    description: Defines service provider attributes and their qualities.
    properties:
      name:
        type: string
        description: The attribute's name.
      type:
        type: string
        description: The attribute's data type.
      referenceTypes:
        type: array
        description: >-
          A multivalued array of strings that indicate the SCIM resource types
          that may be referenced.
        items:
          type: string
      multiValued:
        type: boolean
        description: >-
          A Boolean value indicating the attribute's plurality. True if
          attribute is an enumerable, false otherwise.
      description:
        type: string
        description: The attribute's human-readable description.
      required:
        type: boolean
        description: A Boolean value that specifies whether the attribute is required.
      caseExact:
        type: boolean
        description: >-
          A Boolean value that specifies whether a string attribute is
          case-sensitive.
      mutability:
        type: string
        description: >-
          A single keyword indicating the circumstances under which the value of
          the attribute can be (re)defined.
      uniqueness:
        type: string
        description: >-
          A single keyword value that specifies how the service provider
          enforces uniqueness of attribute values.
      returned:
        type: string
        description: >-
          A single keyword that indicates when an attribute and associated
          values are returned in response

          to a GET request or in response to a PUT, POST, or PATCH request.
      subAttributes:
        type: array
        description: >-
          When an attribute is of type "complex", "subAttributes" defines a set
          of sub-attributes.
        items:
          $ref: '#/definitions/SchemaPropertyResponse'
  ErrorResponse:
    type: object
    description: Represents a SCIM error resource.
    properties:
      schemas:
        type: array
        description: The response schemas.
        items:
          type: string
      status:
        type: string
        description: The HTTP status code.
      scimType:
        description: A SCIM detail error keyword
        allOf:
          - $ref: '#/definitions/ScimErrorType'
      detail:
        type: string
        description: The detail of the error.
  ScimErrorType:
    type: string
    description: An enumeration of possible SCIM error types.
    x-enumNames:
      - invalidFilter
      - tooMany
      - uniqueness
      - mutability
      - invalidSyntax
      - invalidPath
      - noTarget
      - invalidValue
      - invalidVers
      - sensitive
    enum:
      - invalidFilter
      - tooMany
      - uniqueness
      - mutability
      - invalidSyntax
      - invalidPath
      - noTarget
      - invalidValue
      - invalidVers
      - sensitive
tags:
  - name: Schemas
x-servers:
  - url: https://{rootUrl}
    description: null
