Signicat SCIM - Role management API

openapi: 3.2.0
info:
  title: Signicat SCIM - Role management API
  version: ''
  x-meta: Custom metadata
  description: 'Operations tagged SCIM - Role 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 - Role management
paths:
  /api/scim/v2/Roles:
    get:
      tags:
      - SCIM - Role management
      summary: Retrieve roles
      description: 'This request retrieves all roles paginated with option to filter and search provided by:

        - `filter`: option to provide a filter expression

        - `searchQuery`: optional filter for role''s name and external identifier

        - `startIndex`: specifies the starting index for page results (default value: `1`)

        - `count`: number of results returned per page (default value `20`)

        - `sortDirection`: optional direction for sorting (default value: `DESC`)


        **Access requirements**

        - Requires only a valid token.'
      operationId: getRoles
      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: Roles retrieved
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/RoleListResponse'
        '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 - Role management
      summary: Create role
      description: 'Create a new role.


        **Access requirements**

        - Requires a valid token and the `signicat:ownidp:roles:create` global permission.'
      operationId: createRole
      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/RoleResource'
        required: true
      responses:
        '201':
          description: Role created
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/RoleResource'
        '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/Roles/{roleId}:
    get:
      tags:
      - SCIM - Role management
      summary: Retrieve role
      description: 'This request retrieves a role by identifier.


        **Access requirements**

        - Requires only a valid token.'
      operationId: getRole
      parameters:
      - name: roleId
        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: Role retrieved
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/RoleResource'
        '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 role 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'
    delete:
      tags:
      - SCIM - Role management
      summary: Delete role
      description: 'Delete an existing role.


        **Access requirements**

        - Requires a valid token and the `signicat:ownidp:roles:delete` global permission.'
      operationId: deleteRole
      parameters:
      - name: roleId
        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: Role deleted
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResource'
        '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'
    patch:
      tags:
      - SCIM - Role management
      summary: Patch role
      description: 'Update an existing role by identifier.


        **Access requirements**

        - Requires a valid token and the `signicat:ownidp:roles:update` global permission.'
      operationId: patchRole
      parameters:
      - name: roleId
        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: Role updated
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/RoleResource'
        '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 role 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
    AddOperation:
      allOf:
      - $ref: '#/components/schemas/PatchOperation'
      - type: object
        properties:
          value:
            $ref: '#/components/schemas/JsonNode'
    RoleListResponse:
      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/RoleResource'
        id:
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Resources
    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
    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
    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
    RemoveOperation:
      allOf:
      - $ref: '#/components/schemas/PatchOperation'
      - type: object
        properties:
          value:
            $ref: '#/components/schemas/JsonNode'
          removeOpValue:
            $ref: '#/components/schemas/PatchOperation'
      required:
      - path
    ReplaceOperation:
      allOf:
      - $ref: '#/components/schemas/PatchOperation'
      - type: object
        properties:
          value:
            $ref: '#/components/schemas/JsonNode'
          removeOpValue:
            $ref: '#/components/schemas/PatchOperation'
    JsonNode:
      type: 'null'
    ScimPermission:
      type: object
      properties:
        value:
          type: string
    RoleResource:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          uniqueItems: true
        id:
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
          minLength: 1
        displayName:
          type: string
          minLength: 1
        description:
          type:
          - string
          - 'null'
        isEditable:
          type:
          - boolean
          - 'null'
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/ScimPermission'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
      - displayName
      - externalId
      - permissions
  securitySchemes:
    bearerAuth:
      type: http
      name: bearerAuth
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- siam-openapi.json
- signicat-siam-openapi.yml