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/userclouds:userclouds-user-search-indices-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: User Store OpenAPI Spec
  title: User Store User Search Indices API
  version: 1.0.0
servers:
- url: https://your-tenant-name.tenant.userclouds.com
tags:
- name: User Search Indices
paths:
  /userstore/config/searchindices:
    get:
      description: This endpoint returns a paginated list of all user search indices in a tenant.
      parameters:
      - description: A cursor value after which the returned list will start
        in: query
        name: starting_after
        schema:
          description: A cursor value after which the returned list will start
          type:
          - string
          - 'null'
      - description: A cursor value before which the returned list will end
        in: query
        name: ending_before
        schema:
          description: A cursor value before which the returned list will end
          type:
          - string
          - 'null'
      - description: The maximum number of results to be returned per page
        in: query
        name: limit
        schema:
          description: The maximum number of results to be returned per page
          type:
          - string
          - 'null'
      - description: A filter clause to use in the pagination query
        in: query
        name: filter
        schema:
          description: A filter clause to use in the pagination query
          type:
          - string
          - 'null'
      - description: A comma-delimited list of field names to sort the returned results by - the last field name must be 'id'
        in: query
        name: sort_key
        schema:
          description: A comma-delimited list of field names to sort the returned results by - the last field name must be 'id'
          type:
          - string
          - 'null'
      - description: The order in which results should be sorted (ascending or descending)
        in: query
        name: sort_order
        schema:
          description: The order in which results should be sorted (ascending or descending)
          type:
          - string
          - 'null'
      - description: The version of the API to be called
        in: query
        name: version
        schema:
          description: The version of the API to be called
          type:
          - string
          - 'null'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdpListUserSearchIndicesResponse'
          description: OK
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      summary: List User Search Indexes
      tags:
      - User Search Indices
      operationId: getUserstoreConfigSearchindices
      x-operation-id-source: derived
    post:
      description: This endpoint creates a new user search index.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdpCreateUserSearchIndexRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchUserSearchIndex'
          description: Created
        '400':
          description: Bad Request
        '409':
          description: Conflict
        '500':
          description: Internal Server Error
      summary: Create User Search Index
      tags:
      - User Search Indices
      operationId: postUserstoreConfigSearchindices
      x-operation-id-source: derived
  /userstore/config/searchindices/{id}:
    delete:
      description: This endpoint deletes a user search index by ID.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          $ref: '#/components/schemas/UuidUUID'
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '409':
          description: Conflict
        '500':
          description: Internal Server Error
      summary: Delete User Search Index
      tags:
      - User Search Indices
      operationId: deleteUserstoreConfigSearchindicesById
      x-operation-id-source: derived
    get:
      description: This endpoint gets a user search index's configuration by ID.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          $ref: '#/components/schemas/UuidUUID'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchUserSearchIndex'
          description: OK
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      summary: Get User Search Index
      tags:
      - User Search Indices
      operationId: getUserstoreConfigSearchindicesById
      x-operation-id-source: derived
    put:
      description: This endpoint updates a specified user search index.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          $ref: '#/components/schemas/UuidUUID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserstoreUpdateUserSearchIndexRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchUserSearchIndex'
          description: OK
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '409':
          description: Conflict
        '500':
          description: Internal Server Error
      summary: Update User Search Index
      tags:
      - User Search Indices
      operationId: putUserstoreConfigSearchindicesById
      x-operation-id-source: derived
components:
  schemas:
    UuidUUID:
      example: 248df4b7-aa70-47b8-a036-33ac447e668d
      format: uuid
      type: string
    SearchUserSearchIndex:
      properties:
        accessors:
          items:
            $ref: '#/components/schemas/SearchUserSearchIndexAccessor'
          type:
          - array
          - 'null'
        bootstrapped:
          format: date-time
          type: string
        columns:
          items:
            $ref: '#/components/schemas/UserstoreResourceID'
          type:
          - array
          - 'null'
        data_life_cycle_state:
          $ref: '#/components/schemas/UserstoreDataLifeCycleState'
        description:
          type: string
        enabled:
          format: date-time
          type: string
        id:
          $ref: '#/components/schemas/UuidUUID'
        index_name_suffix:
          type: string
        last_regional_bootstrapped_value_ids:
          additionalProperties:
            $ref: '#/components/schemas/UuidUUID'
          type:
          - object
          - 'null'
        name:
          type: string
        searchable:
          format: date-time
          type: string
        settings:
          $ref: '#/components/schemas/SearchIndexSettings'
        type:
          $ref: '#/components/schemas/SearchIndexType'
      type: object
    SearchQueryType:
      enum:
      - term
      - wildcard
      type: string
    SearchNgramIndexSettings:
      properties:
        max_ngram:
          type: integer
        min_ngram:
          type: integer
      type: object
    UserstoreResourceID:
      properties:
        id:
          $ref: '#/components/schemas/UuidUUID'
        name:
          type: string
      type: object
    UserstoreUpdateUserSearchIndexRequest:
      properties:
        index:
          $ref: '#/components/schemas/SearchUserSearchIndex'
      type: object
    IdpCreateUserSearchIndexRequest:
      properties:
        index:
          $ref: '#/components/schemas/SearchUserSearchIndex'
      type: object
    SearchIndexSettings:
      properties:
        ngram:
          $ref: '#/components/schemas/SearchNgramIndexSettings'
      type: object
    UserstoreDataLifeCycleState:
      enum:
      - ''
      - live
      - postdelete
      - predelete
      - softdeleted
      type: string
    SearchUserSearchIndexAccessor:
      properties:
        accessor:
          $ref: '#/components/schemas/UserstoreResourceID'
        query_type:
          $ref: '#/components/schemas/SearchQueryType'
      type: object
    PaginationCursor: {}
    IdpListUserSearchIndicesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/SearchUserSearchIndex'
          type:
          - array
          - 'null'
        has_next:
          type: boolean
        has_prev:
          type: boolean
        next:
          type: string
        prev:
          $ref: '#/components/schemas/PaginationCursor'
      type: object
    SearchIndexType:
      enum:
      - deprecated
      - ngram
      type: string
x-readme:
  explorer-enabled: false