Okta

Okta UserSchema API

The UserSchema API from Okta — 2 operation(s) for userschema.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.okta.com/docs/reference/
📖
Authentication
https://developer.okta.com/docs/guides/implement-grant-type/authcodepkce/main/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/rate-limits/okta-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/openapi/okta-userschema-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/asyncapi/okta-events-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/json-schema/okta-user-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/json-schema/okta-group-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/json-schema/okta-application-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/json-structure/okta-user-structure.json

Other Resources

🔗
OpenAPISource
https://github.com/okta/okta-management-openapi-spec
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/graphql/okta-graphql.md
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/json-ld/okta-context.jsonld
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/rules/okta-rules.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/vocabulary/okta-vocabulary.yml
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/plans/okta-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/okta/refs/heads/main/finops/okta-finops.yml

OpenAPI Specification

okta-userschema-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Okta Application UserSchema API
  description: Allows customers to easily access the Okta API
  termsOfService: https://developer.okta.com/terms/
  contact:
    name: Okta Developer Team
    url: https://developer.okta.com/
    email: devex-public@okta.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.16.0
servers:
- url: https://your-subdomain.okta.com/
tags:
- name: UserSchema
paths:
  /api/v1/meta/schemas/apps/{appInstanceId}/default:
    get:
      tags:
      - UserSchema
      summary: Okta Fetches the Schema for an App User
      description: Fetches the Schema for an App User
      operationId: getApplicationUserSchema
      parameters:
      - name: appInstanceId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSchema'
      security:
      - api_token: []
    post:
      tags:
      - UserSchema
      summary: Okta Partial updates on the User Profile properties of the Application User Schema.
      description: Partial updates on the User Profile properties of the Application User Schema.
      operationId: updateApplicationUserProfile
      parameters:
      - name: appInstanceId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSchema'
        required: false
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSchema'
      security:
      - api_token: []
      x-codegen-request-body-name: body
  /api/v1/meta/schemas/user/{schemaId}:
    get:
      tags:
      - UserSchema
      summary: Okta Fetches the schema for a Schema Id.
      description: Fetches the schema for a Schema Id.
      operationId: getUserSchema
      parameters:
      - name: schemaId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSchema'
      security:
      - api_token: []
    post:
      tags:
      - UserSchema
      description: Partial updates on the User Profile properties of the user schema.
      operationId: updateUserProfile
      parameters:
      - name: schemaId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSchema'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSchema'
      security:
      - api_token: []
      x-codegen-request-body-name: userSchema
components:
  schemas:
    UserSchemaBaseProperties:
      type: object
      properties:
        city:
          $ref: '#/components/schemas/UserSchemaAttribute'
        costCenter:
          $ref: '#/components/schemas/UserSchemaAttribute'
        countryCode:
          $ref: '#/components/schemas/UserSchemaAttribute'
        department:
          $ref: '#/components/schemas/UserSchemaAttribute'
        displayName:
          $ref: '#/components/schemas/UserSchemaAttribute'
        division:
          $ref: '#/components/schemas/UserSchemaAttribute'
        email:
          $ref: '#/components/schemas/UserSchemaAttribute'
        employeeNumber:
          $ref: '#/components/schemas/UserSchemaAttribute'
        firstName:
          $ref: '#/components/schemas/UserSchemaAttribute'
        honorificPrefix:
          $ref: '#/components/schemas/UserSchemaAttribute'
        honorificSuffix:
          $ref: '#/components/schemas/UserSchemaAttribute'
        lastName:
          $ref: '#/components/schemas/UserSchemaAttribute'
        locale:
          $ref: '#/components/schemas/UserSchemaAttribute'
        login:
          $ref: '#/components/schemas/UserSchemaAttribute'
        manager:
          $ref: '#/components/schemas/UserSchemaAttribute'
        managerId:
          $ref: '#/components/schemas/UserSchemaAttribute'
        middleName:
          $ref: '#/components/schemas/UserSchemaAttribute'
        mobilePhone:
          $ref: '#/components/schemas/UserSchemaAttribute'
        nickName:
          $ref: '#/components/schemas/UserSchemaAttribute'
        organization:
          $ref: '#/components/schemas/UserSchemaAttribute'
        postalAddress:
          $ref: '#/components/schemas/UserSchemaAttribute'
        preferredLanguage:
          $ref: '#/components/schemas/UserSchemaAttribute'
        primaryPhone:
          $ref: '#/components/schemas/UserSchemaAttribute'
        profileUrl:
          $ref: '#/components/schemas/UserSchemaAttribute'
        secondEmail:
          $ref: '#/components/schemas/UserSchemaAttribute'
        state:
          $ref: '#/components/schemas/UserSchemaAttribute'
        streetAddress:
          $ref: '#/components/schemas/UserSchemaAttribute'
        timezone:
          $ref: '#/components/schemas/UserSchemaAttribute'
        title:
          $ref: '#/components/schemas/UserSchemaAttribute'
        userType:
          $ref: '#/components/schemas/UserSchemaAttribute'
        zipCode:
          $ref: '#/components/schemas/UserSchemaAttribute'
      x-okta-tags:
      - UserSchema
    UserSchemaDefinitions:
      type: object
      properties:
        base:
          $ref: '#/components/schemas/UserSchemaBase'
        custom:
          $ref: '#/components/schemas/UserSchemaPublic'
      x-okta-tags:
      - UserSchema
    UserSchemaBase:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        properties:
          $ref: '#/components/schemas/UserSchemaBaseProperties'
        required:
          type: array
          items:
            type: string
        type:
          type: string
      x-okta-tags:
      - UserSchema
    UserSchemaPropertiesProfile:
      type: object
      properties:
        allOf:
          type: array
          items:
            $ref: '#/components/schemas/UserSchemaPropertiesProfileItem'
      x-okta-tags:
      - UserSchema
    UserSchemaProperties:
      type: object
      properties:
        profile:
          $ref: '#/components/schemas/UserSchemaPropertiesProfile'
      x-okta-tags:
      - UserSchema
    UserSchemaAttributeMasterPriority:
      type: object
      properties:
        type:
          type: string
        value:
          type: string
      x-okta-tags:
      - UserSchema
    UserSchemaAttributeMasterType:
      type: string
      enum:
      - PROFILE_MASTER
      - OKTA
      - OVERRIDE
      x-okta-tags:
      - UserSchema
    UserSchemaAttributeUnion:
      type: object
      enum:
      - DISABLE
      - ENABLE
      x-okta-tags:
      - UserSchema
    UserSchemaAttributeScope:
      type: object
      enum:
      - SELF
      - NONE
      x-okta-tags:
      - UserSchema
    UserSchemaAttributeEnum:
      type: object
      properties:
        const:
          type: string
        title:
          type: string
      x-okta-tags:
      - UserSchema
    UserSchemaPublic:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UserSchemaAttribute'
        required:
          type: array
          items:
            type: string
        type:
          type: string
      x-okta-tags:
      - UserSchema
    UserSchemaPropertiesProfileItem:
      type: object
      properties:
        $ref:
          type: string
      x-okta-tags:
      - UserSchema
    UserSchemaAttributeType:
      type: string
      enum:
      - string
      - boolean
      - number
      - integer
      - array
      x-okta-tags:
      - UserSchema
    UserSchemaAttributeItems:
      type: object
      properties:
        enum:
          type: array
          items:
            type: string
        oneOf:
          type: array
          items:
            $ref: '#/components/schemas/UserSchemaAttributeEnum'
        type:
          type: string
      x-okta-tags:
      - UserSchema
    UserSchemaAttributeMaster:
      type: object
      properties:
        priority:
          type: array
          items:
            $ref: '#/components/schemas/UserSchemaAttributeMasterPriority'
        type:
          $ref: '#/components/schemas/UserSchemaAttributeMasterType'
      x-okta-tags:
      - UserSchema
    UserSchema:
      type: object
      properties:
        $schema:
          type: string
          readOnly: true
        _links:
          type: object
          additionalProperties:
            type: object
            properties: {}
          readOnly: true
        created:
          type: string
          readOnly: true
        definitions:
          $ref: '#/components/schemas/UserSchemaDefinitions'
        id:
          type: string
          readOnly: true
        lastUpdated:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        properties:
          $ref: '#/components/schemas/UserSchemaProperties'
        title:
          type: string
        type:
          type: string
          readOnly: true
      x-okta-tags:
      - UserSchema
    UserSchemaAttribute:
      type: object
      properties:
        description:
          type: string
        enum:
          type: array
          items:
            type: string
        externalName:
          type: string
        externalNamespace:
          type: string
        items:
          $ref: '#/components/schemas/UserSchemaAttributeItems'
        master:
          $ref: '#/components/schemas/UserSchemaAttributeMaster'
        maxLength:
          type: integer
        minLength:
          type: integer
        mutability:
          type: string
        oneOf:
          type: array
          items:
            $ref: '#/components/schemas/UserSchemaAttributeEnum'
        pattern:
          type: string
        permissions:
          type: array
          items:
            $ref: '#/components/schemas/UserSchemaAttributePermission'
        required:
          type: boolean
        scope:
          $ref: '#/components/schemas/UserSchemaAttributeScope'
        title:
          type: string
        type:
          $ref: '#/components/schemas/UserSchemaAttributeType'
        union:
          $ref: '#/components/schemas/UserSchemaAttributeUnion'
        unique:
          type: string
      x-okta-tags:
      - UserSchema
    UserSchemaAttributePermission:
      type: object
      properties:
        action:
          type: string
        principal:
          type: string
      x-okta-tags:
      - UserSchema
  securitySchemes:
    api_token:
      type: apiKey
      description: SSWS {API Token}
      name: Authorization
      in: header
externalDocs:
  description: Find more info here
  url: https://developer.okta.com/docs/api/getting_started/design_principles.html