Strivacity Outbound Provision API

The Outbound Provision API from Strivacity — 6 operation(s) for outbound provision.

Documentation GitHub OpenAPI

Operations 9

GET /admin/api/v1/identityStores/{identityStoreName}/outboundProvision List outbound provisions #

POST /admin/api/v1/identityStores/{identityStoreName}/outboundProvision Create an outbound provision #

DELETE /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId} Delete an outbound provision #

GET /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId} Get an outbound provision #

PUT /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId} Update an outbound provision #

GET /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/logs List provision function logs #

GET /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/logs/{id} Get the provision function log #

GET /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/status Get status of the provision function #

POST /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/sync Full resync an outbound provision #

Documentation

📖

Documentation

https://docs.strivacity.com/docs/apis-and-sdks

📖

APIReference

https://docs.strivacity.com/reference/getting-started-with-the-admin-api

📖

GettingStarted

https://docs.strivacity.com/reference/getting-started-1

📖

APIReference

https://docs.strivacity.com/reference/getting-started-1

📖

Documentation

https://docs.strivacity.com/docs/oidc-client-using-the-journey-flow-api

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/strivacity/refs/heads/main/openapi/strivacity-outbound-provision-api-openapi.yml

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/strivacity-outbound-provision-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:
  description: API documentation of Admin Portal
  title: Admin Portal Outbound Provision API
  version: v0.0.1
servers:
- url: https://{tenant}
  variables:
    tenant:
      default: example.strivacity.com
      description: Your Strivacity tenant
tags:
- name: Outbound Provision
paths:
  /admin/api/v1/identityStores/{identityStoreName}/outboundProvision:
    get:
      description: 'List the existing outbound provisions of an identity store.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_identity_store |'
      operationId: listOutboundProvisions
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - description: Specifies whether to include outbound provision target statuses in response
        in: query
        name: withStatus
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
                  oneOf:
                  - $ref: '#/components/schemas/OutboundProvisionListResponse'
                  - $ref: '#/components/schemas/OutboundProvisionWithStatusListResponse'
          description: '| TYPE | REQUESTED WITH |

            |:----------------- | ----------------|

            | OutboundProvisionListResponse | withStatus = false |

            | OutboundProvisionWithStatusListResponse | withStatus = true |'
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - read:config_identity_store
      summary: List outbound provisions
      tags:
      - Outbound Provision
    post:
      description: 'Create an outbound provision for an identity store.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_identity_store |'
      operationId: createOutboundProvision
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutboundProvisionInsertRequest'
        required: true
      responses:
        '201':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OutboundProvisionResponse'
          description: Created
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Conflict
      security:
      - securityScheme:
        - write:config_identity_store
      summary: Create an outbound provision
      tags:
      - Outbound Provision
  /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}:
    delete:
      description: 'Delete an outbound provision from an identity store.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_identity_store |'
      operationId: deleteOutboundProvision
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: outboundProvisionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - write:config_identity_store
      summary: Delete an outbound provision
      tags:
      - Outbound Provision
    get:
      description: 'Get an outbound provision by its ID.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_identity_store |'
      operationId: getOutboundProvision
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: outboundProvisionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OutboundProvisionResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - read:config_identity_store
      summary: Get an outbound provision
      tags:
      - Outbound Provision
    put:
      description: 'Update an outbound provision for an identity store.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_identity_store |'
      operationId: updateOutboundProvision
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: outboundProvisionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutboundProvisionUpdateRequest'
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OutboundProvisionResponse'
          description: OK
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Conflict
      security:
      - securityScheme:
        - write:config_identity_store
      summary: Update an outbound provision
      tags:
      - Outbound Provision
  /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/logs:
    get:
      description: 'You can list the provision function logs by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_identity_store |'
      operationId: getProvisionFunctionLogs
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: outboundProvisionId
        required: true
        schema:
          type: string
      - in: query
        name: accountIds
        required: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: accountEventIds
        required: false
        schema:
          type: array
          items:
            type: string
      - in: query
        name: logLevels
        required: false
        schema:
          type: array
          items:
            type: string
      - description: Start date used for filtering
        in: query
        name: startDate
        required: false
        schema:
          type: string
          format: date-time
      - description: End date used for filtering
        in: query
        name: endDate
        required: false
        schema:
          type: string
          format: date-time
      - description: Zero-based page index (0..N)
        in: query
        name: page
        schema:
          type: integer
          format: int64
          default: 0
      - description: The size of the page to be returned
        in: query
        name: size
        schema:
          type: integer
          format: int64
          default: 20
      - description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        in: query
        name: sort
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BaseEventHookLogListResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - read:config_identity_store
      summary: List provision function logs
      tags:
      - Outbound Provision
  /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/logs/{id}:
    get:
      description: 'You can get the provision function log by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_identity_store |'
      operationId: getProvisionFunctionLog
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: outboundProvisionId
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/InternalEventHookLogResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - read:config_identity_store
      summary: Get the provision function log
      tags:
      - Outbound Provision
  /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/status:
    get:
      description: 'You an get the status of the provision function by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_identity_store |'
      operationId: getProvisionStatus
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: outboundProvisionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EventHookStatusResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - read:config_identity_store
      summary: Get status of the provision function
      tags:
      - Outbound Provision
  /admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/sync:
    post:
      description: 'Trigger a full resync for an outbound provision target. This will re-apply the provisioning logic to all accounts in the identity store.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_identity_store |'
      operationId: syncOutboundProvision
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: outboundProvisionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - write:config_identity_store
      summary: Full resync an outbound provision
      tags:
      - Outbound Provision
components:
  schemas:
    EventHookStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - UPGRADING
          - UNHEALTHY
          - NOT_RUNNING
          - NON_DEPLOYED
    OutboundProvisionInsertRequest:
      required:
      - name
      - packageDependencies
      - type
      type: object
      properties:
        code:
          maxLength: 256000
          minLength: 1
          type: string
        description:
          maxLength: 1024
          minLength: 0
          type: string
        enabled:
          type: boolean
          default: false
        filter:
          $ref: '#/components/schemas/FilterRequest'
        maxParallelJobs:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
        name:
          maxLength: 64
          minLength: 3
          pattern: ^$|^[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°]([\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*° ]*[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°])?$
          type: string
        packageDependencies:
          type: object
          additionalProperties:
            type: string
        type:
          type: string
          enum:
          - custom
    OutboundProvisionListResponse:
      type: object
      properties:
        description:
          type: string
        enabled:
          type: boolean
        filter:
          $ref: '#/components/schemas/Filter'
        id:
          type: string
        maxParallelJobs:
          type: integer
          format: int32
        name:
          type: string
        type:
          type: string
          enum:
          - custom
    ProblemJson:
      type: object
      properties:
        detail:
          type: string
        entityName:
          type: string
          description: The name of the entity within the error has occurred
        errorKey:
          type: string
          description: A unique identifier of the error
        fieldErrors:
          type: array
          description: Field constraint violation errors
          items:
            $ref: '#/components/schemas/FieldError'
        message:
          type: string
          description: A unique identifier in format of 'error.{errorKey}'
        params:
          type: array
          description: Further information related to the actual error
          items:
            type: object
            additionalProperties:
              type: object
        path:
          type: string
          description: Request URI
        status:
          type: integer
          description: Status code
          format: int32
        title:
          type: string
      description: Based on [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807)
    FilterRequest:
      type: object
      properties:
        createdAtEndDate:
          type: string
        createdAtStartDate:
          type: string
        disabledAtEndDate:
          type: string
        disabledAtStartDate:
          type: string
        enabled:
          type: boolean
        groups:
          type: string
        groupsFilter:
          type: string
          enum:
          - include
          - exclude
        lastAuthenticationActivityAtEndDate:
          type: string
        lastAuthenticationActivityAtStartDate:
          type: string
        lastLoginAtEndDate:
          type: string
        lastLoginAtStartDate:
          type: string
        neverLoggedIn:
          type: boolean
        organization:
          type: string
        roles:
          type: string
        rolesFilter:
          type: string
          enum:
          - include
          - exclude
        updatedAtEndDate:
          type: string
        updatedAtStartDate:
          type: string
      description: Represents a filter that targets accounts affected by this rule
    FieldError:
      type: object
      properties:
        field:
          type: string
        message:
          type: string
        objectName:
          type: string
    InternalEventHookLogResponse:
      type: object
      properties:
        accountEventId:
          type: string
        accountId:
          type: string
        id:
          type: string
        identityStore:
          type: string
        logSummary:
          $ref: '#/components/schemas/LogSummaryResponse'
        logs:
          type: array
          items:
            $ref: '#/components/schemas/InternalLogResponse'
        timestamp:
          type: string
    LogSummaryResponse:
      type: object
      properties:
        error:
          type: integer
          format: int32
        exception:
          type: boolean
        info:
          type: integer
          format: int32
    InternalLogResponse:
      type: object
      properties:
        level:
          type: string
        message:
          type: string
        timestamp:
          type: string
    Filter:
      type: object
      properties:
        attributes:
          type: object
          additionalProperties:
            type: string
        createdAtEndDate:
          type: string
        createdAtStartDate:
          type: string
        disabledAtEndDate:
          type: string
        disabledAtStartDate:
          type: string
        enabled:
          type: boolean
        groups:
          type: string
        groupsFilter:
          type: string
          enum:
          - include
          - exclude
        lastAuthenticationActivityAtEndDate:
          type: string
        lastAuthenticationActivityAtStartDate:
          type: string
        lastLoginAtEndDate:
          type: string
        lastLoginAtStartDate:
          type: string
        neverLoggedIn:
          type: boolean
        organization:
          type: string
        roles:
          type: string
        rolesFilter:
          type: string
          enum:
          - include
          - exclude
        updatedAtEndDate:
          type: string
        updatedAtStartDate:
          type: string
    BaseEventHookLogListResponse:
      type: object
      properties:
        accountEventId:
          type: string
        accountId:
          type: string
        id:
          type: string
        identityStore:
          type: string
        logSummary:
          $ref: '#/components/schemas/LogSummaryResponse'
        timestamp:
          type: string
    OutboundProvisionWithStatusListResponse:
      type: object
      properties:
        currentLagInMillis:
          type: integer
          format: int64
        description:
          type: string
        enabled:
          type: boolean
        filter:
          $ref: '#/components/schemas/Filter'
        id:
          type: string
        maxParallelJobs:
          type: integer
          format: int32
        name:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - UPGRADING
          - UNHEALTHY
          - NOT_RUNNING
          - NON_DEPLOYED
        type:
          type: string
          enum:
          - custom
    OutboundProvisionResponse:
      type: object
      properties:
        code:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        filter:
          $ref: '#/components/schemas/Filter'
        id:
          type: string
        maxParallelJobs:
          type: integer
          format: int32
        name:
          type: string
        packageDependencies:
          type: object
          additionalProperties:
            type: string
        type:
          type: string
          enum:
          - custom
    OutboundProvisionUpdateRequest:
      required:
      - id
      - name
      - packageDependencies
      - type
      type: object
      properties:
        code:
          maxLength: 256000
          minLength: 1
          type: string
        description:
          maxLength: 1024
          minLength: 0
          type: string
        enabled:
          type: boolean
          default: false
        filter:
          $ref: '#/components/schemas/FilterRequest'
        id:
          pattern: ^[a-zA-Z0-9-]{1,36}$
          type: string
        maxParallelJobs:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
        name:
          maxLength: 64
          minLength: 3
          pattern: ^$|^[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°]([\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*° ]*[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°])?$
          type: string
        packageDependencies:
          type: object
          additionalProperties:
            type: string
        type:
          type: string
          enum:
          - custom
  securitySchemes:
    securityScheme:
      scheme: bearer
      type: http