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-data-types-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 Data Types API
  version: 1.0.0
servers:
- url: https://your-tenant-name.tenant.userclouds.com
tags:
- name: Data Types
paths:
  /userstore/config/datatypes:
    get:
      description: This endpoint returns a paginated list of all data types 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/IdpListDataTypesResponse'
          description: OK
        '400':
          description: Bad Request
        '500':
          description: Internal Server Error
      summary: List Data Types
      tags:
      - Data Types
      operationId: getUserstoreConfigDatatypes
      x-operation-id-source: derived
    post:
      description: This endpoint creates a new data type.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdpCreateDataTypeRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserstoreColumnDataType'
          description: Created
        '400':
          description: Bad Request
        '409':
          description: Conflict
        '500':
          description: Internal Server Error
      summary: Create Data Type
      tags:
      - Data Types
      operationId: postUserstoreConfigDatatypes
      x-operation-id-source: derived
  /userstore/config/datatypes/{id}:
    delete:
      description: This endpoint deletes a data type 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 Data Type
      tags:
      - Data Types
      operationId: deleteUserstoreConfigDatatypesById
      x-operation-id-source: derived
    get:
      description: This endpoint gets a data type'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/UserstoreColumnDataType'
          description: OK
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      summary: Get Data Type
      tags:
      - Data Types
      operationId: getUserstoreConfigDatatypesById
      x-operation-id-source: derived
    put:
      description: This endpoint updates a specified data type.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          $ref: '#/components/schemas/UuidUUID'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserstoreUpdateDataTypeRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserstoreColumnDataType'
          description: OK
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '409':
          description: Conflict
        '500':
          description: Internal Server Error
      summary: Update Data Type
      tags:
      - Data Types
      operationId: putUserstoreConfigDatatypesById
      x-operation-id-source: derived
components:
  schemas:
    UuidUUID:
      example: 248df4b7-aa70-47b8-a036-33ac447e668d
      format: uuid
      type: string
    IdpListDataTypesResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/UserstoreColumnDataType'
          type:
          - array
          - 'null'
        has_next:
          type: boolean
        has_prev:
          type: boolean
        next:
          type: string
        prev:
          $ref: '#/components/schemas/PaginationCursor'
      type: object
    UserstoreUpdateDataTypeRequest:
      properties:
        data_type:
          $ref: '#/components/schemas/UserstoreColumnDataType'
      type: object
    UserstoreResourceID:
      properties:
        id:
          $ref: '#/components/schemas/UuidUUID'
        name:
          type: string
      type: object
    UserstoreCompositeField:
      properties:
        camel_case_name:
          description: Read-only camel-case version of field name, with underscores stripped out. (ex. IDField1)
          type: string
        data_type:
          $ref: '#/components/schemas/UserstoreResourceID'
        ignore_for_uniqueness:
          description: If true, field value will be ignored when comparing two composite values for a uniqueness check.
          type: boolean
        name:
          description: Each part of name must be capitalized or all-caps, separated by underscores. Names may contain alphanumeric characters, and the first part must start with a letter, while other parts may start with a number. (ex. ID_Field_1)
          type: string
        required:
          description: Whether a value must be specified for the field.
          type: boolean
        struct_name:
          description: Read-only snake-case version of field name, with all letters lowercase. (ex. id_field_1)
          type: string
      required:
      - data_type
      - name
      type: object
    PaginationCursor: {}
    UserstoreColumnDataType:
      properties:
        composite_attributes:
          $ref: '#/components/schemas/UserstoreCompositeAttributes'
        description:
          type: string
        id:
          $ref: '#/components/schemas/UuidUUID'
        is_composite_field_type:
          description: Whether the data type can be used for a composite field.
          type: boolean
        is_native:
          description: Whether this is a native non-editable data type.
          type: boolean
        name:
          type: string
      required:
      - name
      - description
      type: object
    UserstoreCompositeAttributes:
      properties:
        fields:
          description: The set of fields associated with a composite data type.
          items:
            $ref: '#/components/schemas/UserstoreCompositeField'
          type:
          - array
          - 'null'
        include_id:
          description: Whether the composite data type must include an id field.
          type: boolean
      type: object
    IdpCreateDataTypeRequest:
      properties:
        data_type:
          $ref: '#/components/schemas/UserstoreColumnDataType'
      type: object
x-readme:
  explorer-enabled: false