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-organization-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 Organization API
  version: v0.0.1
servers:
- url: https://{tenant}
  variables:
    tenant:
      default: example.strivacity.com
      description: Your Strivacity tenant
tags:
- name: Organization
paths:
  /admin/api/v1/identityStores/{identityStoreName}/organizations:
    get:
      description: 'You can list the existing organizations by calling this endpoint.


        | REQUIRED API PERMISSION |

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

        | read:config_identity_store |'
      operationId: getOrganizations
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - description: Filter organizations which are under the provided unique identifier organization id
        in: query
        name: uniqueIdentifierRoot
        required: false
        schema:
          type: string
      - description: Filter organizations where the unique identifier value is matching
        in: query
        name: uniqueIdentifier
        required: false
        schema:
          type: boolean
      - description: Filter organizations where one of the routes value is equal with the provided value
        in: query
        name: route
        required: false
        schema:
          type: string
      - description: Name used for filtering
        in: query
        name: name
        required: false
        schema:
          type: string
      - 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/OrganizationListResponse'
          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 organizations
      tags:
      - Organization
    post:
      description: 'You can create an organization by calling this endpoint.


        | REQUIRED API PERMISSION |

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

        | write:config_identity_store |'
      operationId: createOrganization
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organization_InsertRequest'
        required: true
      responses:
        '201':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
          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 organization
      tags:
      - Organization
  /admin/api/v1/identityStores/{identityStoreName}/organizations/{id}:
    delete:
      description: 'You can delete an organization by calling this endpoint. Organizations assigned to applications, organizations with accounts or roles in it, and parent organizations cannot be deleted.


        | REQUIRED API PERMISSION |

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

        | write:config_identity_store |'
      operationId: deleteOrganization
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: id
        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
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: 'Conflict can happen in various cases:

            - is a parent organization

            - has assigned accounts

            - has assigned roles

            - has assigned clients

            - has assigned applications'
      security:
      - securityScheme:
        - write:config_identity_store
      summary: Delete an organization
      tags:
      - Organization
    get:
      description: 'You can get an organization by calling this endpoint.


        | REQUIRED API PERMISSION |

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

        | read:config_identity_store |'
      operationId: getOrganization
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
          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 organization
      tags:
      - Organization
    put:
      description: 'You can update an organization by calling this endpoint.


        | REQUIRED API PERMISSION |

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

        | write:config_identity_store |'
      operationId: updateOrganization
      parameters:
      - in: path
        name: identityStoreName
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationUpsertRequest'
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
          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 organization
      tags:
      - Organization
components:
  schemas:
    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)
    FieldError:
      type: object
      properties:
        field:
          type: string
        message:
          type: string
        objectName:
          type: string
    OrganizationConfigurationRequest:
      type: object
      properties:
        brand:
          $ref: '#/components/schemas/OrganizationConfigurationBrandRequest'
        organizationRegistrationEnabled:
          type: boolean
          default: false
        selfRegistrationEnabled:
          type: boolean
          default: false
        uniqueIdentifier:
          type: boolean
          default: false
      description: Represents an organization configuration
    Organization_InsertRequest:
      required:
      - name
      - routes
      type: object
      properties:
        configuration:
          $ref: '#/components/schemas/OrganizationConfigurationRequest'
        description:
          maxLength: 1024
          minLength: 0
          type: string
        metadata:
          maxProperties: 50
          type: object
          additionalProperties:
            maxProperties: 50
            type: string
            description: 'Key-value metadata. Max 50 entries. Keys: 1–64 chars, pattern [a-z\d\-_.]+. Values: max 512 chars.'
          description: 'Key-value metadata. Max 50 entries. Keys: 1–64 chars, pattern [a-z\d\-_.]+. Values: max 512 chars.'
        name:
          maxLength: 64
          minLength: 3
          pattern: ^$|^[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°]([\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*° ]*[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°])?$
          type: string
        parent:
          $ref: '#/components/schemas/OnlyIdRequest'
        routes:
          maxItems: 2147483647
          minItems: 1
          type: array
          items:
            maxLength: 63
            minLength: 1
            pattern: ^|[a-z0-9]([-a-z0-9]*[a-z0-9])?$
            type: string
    NameAndIdResponse:
      type: object
      properties:
        id:
          type: string
          description: ID of the represented entity
        name:
          type: string
          description: Name of the represented entity
          example: Entity name
    OrganizationListResponse:
      type: object
      properties:
        configuration:
          $ref: '#/components/schemas/OrganizationConfigurationResponse'
        description:
          type: string
        id:
          type: string
        name:
          type: string
        parent:
          $ref: '#/components/schemas/NameAndIdResponse'
        routes:
          uniqueItems: true
          type: array
          items:
            type: string
    OrganizationConfigurationResponse:
      type: object
      properties:
        brand:
          $ref: '#/components/schemas/OrganizationConfigurationBrandResponse'
        organizationRegistrationEnabled:
          type: boolean
        selfRegistrationEnabled:
          type: boolean
        uniqueIdentifier:
          type: boolean
        uniqueIdentifierRoot:
          type: string
    OrganizationConfigurationBrandRequest:
      type: object
      properties:
        backgroundColor:
          type: string
        faviconUrl:
          type: string
        logoUrl:
          type: string
        primaryColor:
          type: string
    OrganizationUpsertRequest:
      required:
      - id
      - name
      - routes
      type: object
      properties:
        configuration:
          $ref: '#/components/schemas/OrganizationConfigurationRequest'
        description:
          maxLength: 1024
          minLength: 0
          type: string
        id:
          type: string
        metadata:
          maxProperties: 50
          type: object
          additionalProperties:
            maxProperties: 50
            type: string
            description: 'Key-value metadata. Max 50 entries. Keys: 1–64 chars, pattern [a-z\d\-_.]+. Values: max 512 chars.'
          description: 'Key-value metadata. Max 50 entries. Keys: 1–64 chars, pattern [a-z\d\-_.]+. Values: max 512 chars.'
        name:
          maxLength: 64
          minLength: 3
          pattern: ^$|^[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°]([\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*° ]*[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°])?$
          type: string
        parent:
          $ref: '#/components/schemas/OnlyIdRequest'
        routes:
          maxItems: 2147483647
          minItems: 1
          type: array
          items:
            maxLength: 63
            minLength: 1
            pattern: ^|[a-z0-9]([-a-z0-9]*[a-z0-9])?$
            type: string
    OrganizationConfigurationBrandResponse:
      type: object
      properties:
        backgroundColor:
          type: string
        faviconUrl:
          type: string
        logoUrl:
          type: string
        primaryColor:
          type: string
    OnlyIdRequest:
      required:
      - id
      type: object
      properties:
        id:
          pattern: ^[a-zA-Z0-9-]{1,36}$
          type: string
    OrganizationResponse:
      type: object
      properties:
        configuration:
          $ref: '#/components/schemas/OrganizationConfigurationResponse'
        description:
          type: string
        id:
          type: string
        metadata:
          type: object
          additionalProperties:
            type: string
        name:
          type: string
        parent:
          $ref: '#/components/schemas/NameAndIdResponse'
        routes:
          uniqueItems: true
          type: array
          items:
            type: string
  securitySchemes:
    securityScheme:
      scheme: bearer
      type: http