Signicat SCIM - Organization management API

openapi: 3.2.0
info:
  title: Signicat SCIM - Organization management API
  version: ''
  x-meta: Custom metadata
  description: 'Operations tagged SCIM - Organization management across 2 of this provider''s published API definitions: siam-openapi.json, signicat-siam-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.signicat.com/ownidp
  description: Generated server url
security:
- bearerAuth: []
tags:
- name: SCIM - Organization management
paths:
  /api/scim/v2/Organizations:
    get:
      tags:
      - SCIM - Organization management
      summary: Retrieve a list of organizations
      description: 'Retrieves a paginated and filtered list of organizations.


        The organization is main resource in the SCIM service, holding organization data and associations

        to other resources through roles and memberships.


        ### Query Parameters

        - `filter`: A SCIM filter expression. Currently, support is limited to filtering with contains operation

        by `name'', ''id'', ''parent'':

        - `name co ""`: Contains substring (case-insensitive).

        - `searchQuery`: A simple text search across organization ID and name fields.

        - `startIndex`: The 1-based index of the first result. Defaults to `1`.

        - `count`: The number of results to return per page. Defaults to `20`.

        - `sortOrder`: The sort direction. Accepts `ASC` or `DESC`. Defaults to `DESC`.


        ### Access Requirements

        - Global permission `signicat:ownidp:user-groups:read`.

        - On a specific membership, the permission `signicat:ownidp:user-groups:read` is required.

        Giving read access to all organizations found on those memberships (with limited details)'
      operationId: getOrganizations
      parameters:
      - name: filter
        in: query
        required: false
        schema:
          type: string
      - name: searchQuery
        in: query
        required: false
        schema:
          type: string
          default: ''
      - name: startIndex
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 20
      - name: sortOrder
        in: query
        required: false
        schema:
          type: string
          default: DESC
          enum:
          - ASC
          - DESC
      - name: Signicat-AccountId
        in: header
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      - name: signicat-accountid
        in: query
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Organizations retrieved
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/OrganizationListResponse'
        '400':
          description: Bad request, some of the data provided might be invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized call, token is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden call, you need a specific permission to access this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal error occurred, please let us know
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - SCIM - Organization management
      summary: Create organization
      description: 'An organization is a type of group that can be arranged hierarchically.

        Users gain access to organizations through memberships, with roles or attributes defining their permissions.


        This operation create a new organization.

        For convenience, passing custom attributes, can use either the id or the name of the attribute definition


        **Access requirements**

        - Global: `signicat:ownidp:user-groups:create` permission

        - Scoped: `signicat:ownidp:user-groups:create` permission

        - Scoped access means the permission must be granted via a membership in this group

        or one of its parent groups. If created group does not have a parent, user requires global access'
      operationId: createOrganization
      parameters:
      - name: Signicat-AccountId
        in: header
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      - name: signicat-accountid
        in: query
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationRequestResource'
        required: true
      responses:
        '201':
          description: Organization created
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/OrganizationResource'
        '400':
          description: Bad request, some of the data provided might be invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized call, token is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden call, you need a specific permission to access this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal error occurred, please let us know
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://api.signicat.com/ownidp
      description: Generated server url
  /api/scim/v2/Organizations/{organizationId}:
    get:
      tags:
      - SCIM - Organization management
      summary: Retrieve a single organization
      description: 'Retrieves a single organization by their unique identifier.


        The organization is main resource in the SCIM service, holding organization data and associations

        to other resources through roles and memberships.


        ### Access Requirements

        - Requires the global permission `signicat:ownidp:user-groups:read`.

        - On a specific membership, the permission `signicat:ownidp:user-groups:read` is required.

        Giving read access to all organizations found on those memberships'
      operationId: getOrganization
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: Signicat-AccountId
        in: header
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      - name: signicat-accountid
        in: query
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Organization retrieved
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/OrganizationResource'
        '400':
          description: Bad request, some of the data provided might be invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized call, token is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden call, you need a specific permission to access this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Did not find the organization based on the id provided
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResource'
        '500':
          description: An internal error occurred, please let us know
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - SCIM - Organization management
      summary: Delete organization
      description: 'An organization is a type of group that can be arranged hierarchically.

        Users gain access to organizations through memberships, with roles or attributes defining their permissions.


        This operation removes an existing organization.


        **Access requirements**

        - Global: `signicat:ownidp:user-groups:delete` permission

        - Scoped: `signicat:ownidp:user-groups:delete` permission

        - Scoped access means the permission must be granted via a membership in this group

        or one of its parent groups.'
      operationId: deleteOrganization
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: Signicat-AccountId
        in: header
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      - name: signicat-accountid
        in: query
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      responses:
        '204':
          description: Organization removed
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request, some of the data provided might be invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized call, token is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden call, you need a specific permission to access this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Did not find the organization based on the provided id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResource'
        '500':
          description: An internal error occurred, please let us know
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
      - SCIM - Organization management
      summary: Patch organization
      description: 'An organization is a type of group that can be arranged hierarchically.

        Users gain access to organizations through memberships, with roles or attributes defining their permissions.


        This operation changes an existing organization.

        For convenience, passing custom attributes in the path,

        can use either the id or the name of the attribute definition


        **Access requirements**

        - Global: `signicat:ownidp:user-groups:update` permission

        - Scoped: `signicat:ownidp:user-groups:update` permission

        - Scoped access means the permission must be granted via a membership in this group

        or one of its parent groups.'
      operationId: patchOrganization
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: Signicat-AccountId
        in: header
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      - name: signicat-accountid
        in: query
        description: 'Identifies the DTP account for the request.


          One of the following must be provided:

          - `Signicat-AccountId` header

          - `signicat-accountid` query parameter


          If neither is provided, the system will attempt to resolve the account from the token claims.

          If both are provided, the values must be identical.

          '
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchRequest'
        required: true
      responses:
        '200':
          description: Organization updated
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/OrganizationResource'
        '400':
          description: Bad request, some of the data provided might be invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized call, token is required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden call, you need a specific permission to access this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Did not find the organization based on the value provided
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResource'
        '500':
          description: An internal error occurred, please let us know
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    servers:
    - url: https://api.signicat.com/ownidp
      description: Generated server url
components:
  schemas:
    ErrorResponse:
      properties:
        title:
          type: string
        status:
          type: integer
          format: int32
        code:
          type: string
        timestamp:
          type: string
        traceId:
          type: string
        spanId:
          type: string
        detail:
          type: string
        type:
          type: string
        requestUri:
          type: string
    ScimInboundCustomAttribute:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
    ScimOrganization:
      type: 'null'
      properties:
        value:
          type: string
        display:
          type: string
        ref:
          type: string
        type:
          type: string
          enum:
          - GROUP
          - ORGANIZATION
          - ACCOUNT
    OrganizationRequestResource:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          uniqueItems: true
        id:
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
        name:
          type: string
        active:
          type:
          - boolean
          - 'null'
        customAttributes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScimInboundCustomAttribute'
          writeOnly: true
        parent:
          type:
          - string
          - 'null'
        meta:
          $ref: '#/components/schemas/Meta'
    AddOperation:
      allOf:
      - $ref: '#/components/schemas/PatchOperation'
      - type: object
        properties:
          value:
            $ref: '#/components/schemas/JsonNode'
    OrganizationResource:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          uniqueItems: true
        id:
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        active:
          type:
          - boolean
          - 'null'
        customAttributes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScimInboundCustomAttribute'
          writeOnly: true
        parent:
          $ref: '#/components/schemas/ScimOrganization'
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: 'null'
      properties:
        resourceType:
          type:
          - string
          - 'null'
        created:
          type:
          - string
          - 'null'
          format: date-time
        lastModified:
          type:
          - string
          - 'null'
          format: date-time
        location:
          type:
          - string
          - 'null'
          format: uri
        version:
          type:
          - string
          - 'null'
        createdMillis:
          $ref: '#/components/schemas/Meta'
          writeOnly: true
        lastModifiedMillis:
          $ref: '#/components/schemas/Meta'
          writeOnly: true
    ReplaceOperation:
      allOf:
      - $ref: '#/components/schemas/PatchOperation'
      - type: object
        properties:
          value:
            $ref: '#/components/schemas/JsonNode'
          removeOpValue:
            $ref: '#/components/schemas/PatchOperation'
    PatchOperation:
      type: object
      discriminator:
        propertyName: op
      properties:
        path:
          type:
          - string
          - 'null'
        removeOpValue:
          oneOf:
          - $ref: '#/components/schemas/AddOperation'
          - $ref: '#/components/schemas/RemoveOperation'
          - $ref: '#/components/schemas/ReplaceOperation'
          writeOnly: true
        op:
          type: string
      required:
      - op
    PatchRequest:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          uniqueItems: true
        id:
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
        Operations:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/AddOperation'
            - $ref: '#/components/schemas/RemoveOperation'
            - $ref: '#/components/schemas/ReplaceOperation'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Operations
    RemoveOperation:
      allOf:
      - $ref: '#/components/schemas/PatchOperation'
      - type: object
        properties:
          value:
            $ref: '#/components/schemas/JsonNode'
          removeOpValue:
            $ref: '#/components/schemas/PatchOperation'
      required:
      - path
    OrganizationListResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          uniqueItems: true
        totalResults:
          type: integer
          format: int32
        itemsPerPage:
          type:
          - integer
          - 'null'
          format: int32
        startIndex:
          type:
          - integer
          - 'null'
          format: int32
        previousCursor:
          type:
          - string
          - 'null'
        nextCursor:
          type:
          - string
          - 'null'
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationResource'
        id:
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Resources
    JsonNode:
      type: 'null'
    ErrorResource:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          uniqueItems: true
        detail:
          type:
          - string
          - 'null'
        status:
          type: integer
          format: int32
        traceId:
          type: string
        spanId:
          type: string
        requestUri:
          type: string
        title:
          type: string
        code:
          type: string
        timestamp:
          type: string
        type:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      name: bearerAuth
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- siam-openapi.json
- signicat-siam-openapi.yml