Arize Phoenix

Arize Phoenix Oauth2 API

The Oauth2 API from Arize Phoenix — 2 operation(s) for oauth2.

GitHub OpenAPI

Documentation

📖
Documentation
https://arize.com/docs/phoenix

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/phoenix/refs/heads/main/openapi/phoenix-oauth2-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/phoenix/refs/heads/main/json-schema/phoenix-span.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/phoenix/refs/heads/main/json-schema/phoenix-dataset.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/phoenix/refs/heads/main/json-schema/phoenix-experiment.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/phoenix/refs/heads/main/json-schema/phoenix-annotationresult.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/phoenix/refs/heads/main/json-schema/phoenix-project.json

Other Resources

🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/phoenix/refs/heads/main/vocabulary/phoenix-vocabulary.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/phoenix/refs/heads/main/json-ld/phoenix-context.jsonld
🔗
PythonSDK
https://pypi.org/project/arize-phoenix-client/
🔗
TypeScriptSDK
https://www.npmjs.com/package/@arizeai/phoenix-client

OpenAPI Specification

phoenix-oauth2-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Arize-Phoenix REST annotation_configs Oauth2 API
  description: Schema for Arize-Phoenix REST API
  version: '1.0'
tags:
- name: Oauth2
paths:
  /oauth2/{idp_name}/login:
    post:
      summary: Login
      operationId: login_oauth2__idp_name__login_post
      parameters:
      - name: idp_name
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          pattern: '[a-z0-9_]+'
          title: Idp Name
      - name: returnUrl
        in: query
        required: false
        schema:
          type: string
          nullable: true
          title: Returnurl
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Oauth2
    get:
      summary: Login
      operationId: login_oauth2__idp_name__login_get
      parameters:
      - name: idp_name
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          pattern: '[a-z0-9_]+'
          title: Idp Name
      - name: returnUrl
        in: query
        required: false
        schema:
          type: string
          nullable: true
          title: Returnurl
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Oauth2
  /oauth2/{idp_name}/tokens:
    get:
      summary: Create Tokens
      operationId: create_tokens_oauth2__idp_name__tokens_get
      parameters:
      - name: idp_name
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          pattern: '[a-z0-9_]+'
          title: Idp Name
      - name: state
        in: query
        required: true
        schema:
          type: string
          title: State
      - name: code
        in: query
        required: false
        schema:
          type: string
          nullable: true
          title: Code
      - name: error
        in: query
        required: false
        schema:
          type: string
          nullable: true
          title: Error
      - name: error_description
        in: query
        required: false
        schema:
          type: string
          nullable: true
          title: Error Description
      - name: phoenix-oauth2-state
        in: cookie
        required: true
        schema:
          type: string
          title: Phoenix-Oauth2-State
      - name: phoenix-oauth2-nonce
        in: cookie
        required: true
        schema:
          type: string
          title: Phoenix-Oauth2-Nonce
      - name: phoenix-oauth2-code-verifier
        in: cookie
        required: false
        schema:
          type: string
          nullable: true
          title: Phoenix-Oauth2-Code-Verifier
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Oauth2
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError