Signicat

Signicat SCIM - User invitation management API

The SCIM - User invitation management API from Signicat — 5 operation(s) for scim - user invitation management.

Documentation GitHub OpenAPI

Operations 6

POST /api/scim/v2/InviteUser Send new invitation #

POST /api/scim/v2/InviteUser/global Send new invitation on global context #

POST /api/scim/v2/InviteUser/Global Send new invitation on global context #

GET /api/scim/v2/Invitations Retrieve invitations #

GET /api/scim/v2/Invitations/{invitationId} Retrieve single invitation #

DELETE /api/scim/v2/Invitations/{invitationId} Delete invitation #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/signicat:signicat-scim-user-invitation-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Signicat SCIM - User invitation management API
  version: ''
  x-meta: Custom metadata
  description: 'Operations tagged SCIM - User invitation 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 - User invitation management
paths:
  /api/scim/v2/InviteUser:
    post:
      tags:
      - SCIM - User invitation management
      summary: Send new invitation
      description: 'This request invites a new user by providing the metadata in the request body.


        **Access requirements**

        - Requires a valid token and the access `signicat:ownidp:invitations:create` in the scoped group.'
      operationId: inviteUser
      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/ScimInvitationRequest'
        required: true
      responses:
        '204':
          description: User invited
          content:
            application/scim+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'
        '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/InviteUser/global:
    post:
      tags:
      - SCIM - User invitation management
      summary: Send new invitation on global context
      description: 'This request invites a new user by providing the metadata in the request body.


        **Access requirements**

        - Requires a valid token and the access `signicat:ownidp:invitations:create` in the global scope.'
      operationId: inviteUserGlobal
      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/ScimGlobalInvitationRequest'
        required: true
      responses:
        '204':
          description: User invited
          content:
            application/scim+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'
        '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/InviteUser/Global:
    post:
      tags:
      - SCIM - User invitation management
      summary: Send new invitation on global context
      description: 'This request invites a new user by providing the metadata in the request body.


        **Access requirements**

        - Requires a valid token and the access `signicat:ownidp:invitations:create` in the global scope.'
      operationId: inviteUserGlobal_1
      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/ScimGlobalInvitationRequest'
        required: true
      responses:
        '204':
          description: User invited
          content:
            application/scim+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'
        '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/Invitations:
    get:
      tags:
      - SCIM - User invitation management
      summary: Retrieve invitations
      description: 'This request retrieves a list of invitations paginated provided by:

        - `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: getInvitations
      parameters:
      - 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: Retrieval of invitations
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/InvitationListResponse'
        '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/Invitations/{invitationId}:
    get:
      tags:
      - SCIM - User invitation management
      summary: Retrieve single invitation
      description: 'This request retrieves a single invitation by identifier.


        **Access requirements**

        - Requires a valid token and the global `signicat:ownidp:invitations:read` permission.'
      operationId: getInvitation
      parameters:
      - name: invitationId
        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: Retrieval of an invitation
          content:
            application/scim+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 Invitation based on the provided id
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An internal error occurred, please let us know
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - SCIM - User invitation management
      summary: Delete invitation
      description: 'This request deletes an existing invitation by identifier.


        **Access requirements**

        - Requires a valid token and the global `signicat:ownidp:invitations:delete` permission.'
      operationId: deleteInvitation
      parameters:
      - name: invitationId
        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: Removal of invitation
          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 Invitation based on the provided id
          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
components:
  schemas:
    ScimAttributeCommand:
      type: object
      properties:
        id:
          type: string
          maxLength: 36
          minLength: 0
        value:
          type: string
      required:
      - id
    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
    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
    ScimInvitationRequest:
      type: object
      properties:
        subjectId:
          type: string
          maxLength: 150
          minLength: 1
        email:
          type: string
          format: email
          minLength: 1
        organization:
          type: string
          minLength: 1
        roles:
          type: array
          items:
            type: string
          uniqueItems: true
        customAttributes:
          type: array
          items:
            $ref: '#/components/schemas/ScimAttributeCommand'
        subjectAttributes:
          type: array
          items:
            $ref: '#/components/schemas/ScimAttributeCommand'
      required:
      - email
      - organization
    InvitationListResponse:
      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/InvitationResource'
        id:
          type:
          - string
          - 'null'
        externalId:
          type:
          - string
          - 'null'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Resources
    InvitationResource:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        organization:
          $ref: '#/components/schemas/GroupResponse'
        invitedBy:
          type:
          - string
          - 'null'
        emailAddress:
          type:
          - string
          - 'null'
        timestamp:
          type:
          - string
          - 'null'
          format: date-time
        accepted:
          type:
          - boolean
          - 'null'
    ScimGlobalInvitationRequest:
      type: object
      properties:
        subjectId:
          type: string
          maxLength: 150
          minLength: 1
        email:
          type: string
          format: email
          minLength: 1
        roles:
          type: array
          items:
            type: string
            minLength: 1
          minItems: 1
          uniqueItems: true
        subjectAttributes:
          type: array
          items:
            $ref: '#/components/schemas/ScimAttributeCommand'
      required:
      - email
      - roles
    GroupResponse:
      type: 'null'
      properties:
        id:
          type: string
        displayName:
          type: string
        type:
          type: string
          enum:
          - GROUP
          - ORGANIZATION
          - ACCOUNT
  securitySchemes:
    bearerAuth:
      type: http
      name: bearerAuth
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- siam-openapi.json
- signicat-siam-openapi.yml