This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/swagger.yaml

7599 lines
188 KiB
YAML
Executable File

swagger: '2.0'
info:
title: passbook API
contact:
email: hello@beryju.org
license:
name: MIT License
version: v2
basePath: /api/v2beta
consumes:
- application/json
produces:
- application/json
securityDefinitions:
token:
type: apiKey
name: Authorization
in: header
security:
- token: []
paths:
/audit/events/:
get:
operationId: audit_events_list
description: Event Read-Only Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Event'
tags:
- audit
parameters: []
/audit/events/{event_uuid}/:
get:
operationId: audit_events_read
description: Event Read-Only Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Event'
tags:
- audit
parameters:
- name: event_uuid
in: path
description: A UUID string identifying this Audit Event.
required: true
type: string
format: uuid
/core/applications/:
get:
operationId: core_applications_list
description: Application Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Application'
tags:
- core
post:
operationId: core_applications_create
description: Application Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Application'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Application'
tags:
- core
parameters: []
/core/applications/{pbm_uuid}/:
get:
operationId: core_applications_read
description: Application Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Application'
tags:
- core
put:
operationId: core_applications_update
description: Application Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Application'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Application'
tags:
- core
patch:
operationId: core_applications_partial_update
description: Application Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Application'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Application'
tags:
- core
delete:
operationId: core_applications_delete
description: Application Viewset
parameters: []
responses:
'204':
description: ''
tags:
- core
parameters:
- name: pbm_uuid
in: path
description: A UUID string identifying this Application.
required: true
type: string
format: uuid
/core/groups/:
get:
operationId: core_groups_list
description: Group Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Group'
tags:
- core
post:
operationId: core_groups_create
description: Group Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- core
parameters: []
/core/groups/{group_uuid}/:
get:
operationId: core_groups_read
description: Group Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- core
put:
operationId: core_groups_update
description: Group Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- core
patch:
operationId: core_groups_partial_update
description: Group Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Group'
tags:
- core
delete:
operationId: core_groups_delete
description: Group Viewset
parameters: []
responses:
'204':
description: ''
tags:
- core
parameters:
- name: group_uuid
in: path
description: A UUID string identifying this group.
required: true
type: string
format: uuid
/core/users/:
get:
operationId: core_users_list
description: User Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/User'
tags:
- core
post:
operationId: core_users_create
description: User Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/User'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- core
parameters: []
/core/users/{id}/:
get:
operationId: core_users_read
description: User Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- core
put:
operationId: core_users_update
description: User Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/User'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- core
patch:
operationId: core_users_partial_update
description: User Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/User'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/User'
tags:
- core
delete:
operationId: core_users_delete
description: User Viewset
parameters: []
responses:
'204':
description: ''
tags:
- core
parameters:
- name: id
in: path
description: A unique integer value identifying this User.
required: true
type: integer
/crypto/certificatekeypairs/:
get:
operationId: crypto_certificatekeypairs_list
description: CertificateKeyPair Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/CertificateKeyPair'
tags:
- crypto
post:
operationId: crypto_certificatekeypairs_create
description: CertificateKeyPair Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CertificateKeyPair'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/CertificateKeyPair'
tags:
- crypto
parameters: []
/crypto/certificatekeypairs/{kp_uuid}/:
get:
operationId: crypto_certificatekeypairs_read
description: CertificateKeyPair Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CertificateKeyPair'
tags:
- crypto
put:
operationId: crypto_certificatekeypairs_update
description: CertificateKeyPair Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CertificateKeyPair'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CertificateKeyPair'
tags:
- crypto
patch:
operationId: crypto_certificatekeypairs_partial_update
description: CertificateKeyPair Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CertificateKeyPair'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CertificateKeyPair'
tags:
- crypto
delete:
operationId: crypto_certificatekeypairs_delete
description: CertificateKeyPair Viewset
parameters: []
responses:
'204':
description: ''
tags:
- crypto
parameters:
- name: kp_uuid
in: path
description: A UUID string identifying this Certificate-Key Pair.
required: true
type: string
format: uuid
/flows/bindings/:
get:
operationId: flows_bindings_list
description: FlowStageBinding Viewset
parameters:
- name: pbm_uuid
in: query
description: ''
required: false
type: string
- name: policies
in: query
description: ''
required: false
type: string
- name: fsb_uuid
in: query
description: ''
required: false
type: string
- name: target
in: query
description: ''
required: false
type: string
- name: stage
in: query
description: ''
required: false
type: string
- name: re_evaluate_policies
in: query
description: ''
required: false
type: string
- name: order
in: query
description: ''
required: false
type: number
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/FlowStageBinding'
tags:
- flows
post:
operationId: flows_bindings_create
description: FlowStageBinding Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/FlowStageBinding'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/FlowStageBinding'
tags:
- flows
parameters: []
/flows/bindings/{fsb_uuid}/:
get:
operationId: flows_bindings_read
description: FlowStageBinding Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FlowStageBinding'
tags:
- flows
put:
operationId: flows_bindings_update
description: FlowStageBinding Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/FlowStageBinding'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FlowStageBinding'
tags:
- flows
patch:
operationId: flows_bindings_partial_update
description: FlowStageBinding Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/FlowStageBinding'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/FlowStageBinding'
tags:
- flows
delete:
operationId: flows_bindings_delete
description: FlowStageBinding Viewset
parameters: []
responses:
'204':
description: ''
tags:
- flows
parameters:
- name: fsb_uuid
in: path
description: A UUID string identifying this Flow Stage Binding.
required: true
type: string
format: uuid
/flows/instances/:
get:
operationId: flows_instances_list
description: Flow Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Flow'
tags:
- flows
post:
operationId: flows_instances_create
description: Flow Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Flow'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Flow'
tags:
- flows
parameters: []
/flows/instances/{flow_uuid}/:
get:
operationId: flows_instances_read
description: Flow Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Flow'
tags:
- flows
put:
operationId: flows_instances_update
description: Flow Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Flow'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Flow'
tags:
- flows
patch:
operationId: flows_instances_partial_update
description: Flow Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Flow'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Flow'
tags:
- flows
delete:
operationId: flows_instances_delete
description: Flow Viewset
parameters: []
responses:
'204':
description: ''
tags:
- flows
parameters:
- name: flow_uuid
in: path
description: A UUID string identifying this Flow.
required: true
type: string
format: uuid
/outposts/outposts/:
get:
operationId: outposts_outposts_list
description: Outpost Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Outpost'
tags:
- outposts
post:
operationId: outposts_outposts_create
description: Outpost Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Outpost'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Outpost'
tags:
- outposts
parameters: []
/outposts/outposts/{uuid}/:
get:
operationId: outposts_outposts_read
description: Outpost Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Outpost'
tags:
- outposts
put:
operationId: outposts_outposts_update
description: Outpost Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Outpost'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Outpost'
tags:
- outposts
patch:
operationId: outposts_outposts_partial_update
description: Outpost Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Outpost'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Outpost'
tags:
- outposts
delete:
operationId: outposts_outposts_delete
description: Outpost Viewset
parameters: []
responses:
'204':
description: ''
tags:
- outposts
parameters:
- name: uuid
in: path
description: A UUID string identifying this outpost.
required: true
type: string
format: uuid
/outposts/proxy/:
get:
operationId: outposts_proxy_list
description: ProxyProvider Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ProxyOutpostConfig'
tags:
- outposts
post:
operationId: outposts_proxy_create
description: ProxyProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ProxyOutpostConfig'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ProxyOutpostConfig'
tags:
- outposts
parameters: []
/outposts/proxy/{id}/:
get:
operationId: outposts_proxy_read
description: ProxyProvider Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProxyOutpostConfig'
tags:
- outposts
put:
operationId: outposts_proxy_update
description: ProxyProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ProxyOutpostConfig'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProxyOutpostConfig'
tags:
- outposts
patch:
operationId: outposts_proxy_partial_update
description: ProxyProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ProxyOutpostConfig'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProxyOutpostConfig'
tags:
- outposts
delete:
operationId: outposts_proxy_delete
description: ProxyProvider Viewset
parameters: []
responses:
'204':
description: ''
tags:
- outposts
parameters:
- name: id
in: path
description: A unique integer value identifying this Proxy Provider.
required: true
type: integer
/policies/all/:
get:
operationId: policies_all_list
description: Policy Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Policy'
tags:
- policies
parameters: []
/policies/all/{policy_uuid}/:
get:
operationId: policies_all_read
description: Policy Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Policy'
tags:
- policies
parameters:
- name: policy_uuid
in: path
description: A UUID string identifying this Policy.
required: true
type: string
format: uuid
/policies/bindings/:
get:
operationId: policies_bindings_list
description: PolicyBinding Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PolicyBinding'
tags:
- policies
post:
operationId: policies_bindings_create
description: PolicyBinding Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PolicyBinding'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PolicyBinding'
tags:
- policies
parameters: []
/policies/bindings/{policy_binding_uuid}/:
get:
operationId: policies_bindings_read
description: PolicyBinding Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PolicyBinding'
tags:
- policies
put:
operationId: policies_bindings_update
description: PolicyBinding Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PolicyBinding'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PolicyBinding'
tags:
- policies
patch:
operationId: policies_bindings_partial_update
description: PolicyBinding Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PolicyBinding'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PolicyBinding'
tags:
- policies
delete:
operationId: policies_bindings_delete
description: PolicyBinding Viewset
parameters: []
responses:
'204':
description: ''
tags:
- policies
parameters:
- name: policy_binding_uuid
in: path
description: A UUID string identifying this Policy Binding.
required: true
type: string
format: uuid
/policies/dummy/:
get:
operationId: policies_dummy_list
description: Dummy Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/DummyPolicy'
tags:
- policies
post:
operationId: policies_dummy_create
description: Dummy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/DummyPolicy'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/DummyPolicy'
tags:
- policies
parameters: []
/policies/dummy/{policy_uuid}/:
get:
operationId: policies_dummy_read
description: Dummy Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DummyPolicy'
tags:
- policies
put:
operationId: policies_dummy_update
description: Dummy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/DummyPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DummyPolicy'
tags:
- policies
patch:
operationId: policies_dummy_partial_update
description: Dummy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/DummyPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DummyPolicy'
tags:
- policies
delete:
operationId: policies_dummy_delete
description: Dummy Viewset
parameters: []
responses:
'204':
description: ''
tags:
- policies
parameters:
- name: policy_uuid
in: path
description: A UUID string identifying this Dummy Policy.
required: true
type: string
format: uuid
/policies/expression/:
get:
operationId: policies_expression_list
description: Source Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ExpressionPolicy'
tags:
- policies
post:
operationId: policies_expression_create
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ExpressionPolicy'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ExpressionPolicy'
tags:
- policies
parameters: []
/policies/expression/{policy_uuid}/:
get:
operationId: policies_expression_read
description: Source Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ExpressionPolicy'
tags:
- policies
put:
operationId: policies_expression_update
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ExpressionPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ExpressionPolicy'
tags:
- policies
patch:
operationId: policies_expression_partial_update
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ExpressionPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ExpressionPolicy'
tags:
- policies
delete:
operationId: policies_expression_delete
description: Source Viewset
parameters: []
responses:
'204':
description: ''
tags:
- policies
parameters:
- name: policy_uuid
in: path
description: A UUID string identifying this Expression Policy.
required: true
type: string
format: uuid
/policies/group_membership/:
get:
operationId: policies_group_membership_list
description: Group Membership Policy Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/GroupMembershipPolicy'
tags:
- policies
post:
operationId: policies_group_membership_create
description: Group Membership Policy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/GroupMembershipPolicy'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/GroupMembershipPolicy'
tags:
- policies
parameters: []
/policies/group_membership/{policy_uuid}/:
get:
operationId: policies_group_membership_read
description: Group Membership Policy Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/GroupMembershipPolicy'
tags:
- policies
put:
operationId: policies_group_membership_update
description: Group Membership Policy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/GroupMembershipPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/GroupMembershipPolicy'
tags:
- policies
patch:
operationId: policies_group_membership_partial_update
description: Group Membership Policy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/GroupMembershipPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/GroupMembershipPolicy'
tags:
- policies
delete:
operationId: policies_group_membership_delete
description: Group Membership Policy Viewset
parameters: []
responses:
'204':
description: ''
tags:
- policies
parameters:
- name: policy_uuid
in: path
description: A UUID string identifying this Group Membership Policy.
required: true
type: string
format: uuid
/policies/haveibeenpwned/:
get:
operationId: policies_haveibeenpwned_list
description: Source Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/HaveIBeenPwendPolicy'
tags:
- policies
post:
operationId: policies_haveibeenpwned_create
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/HaveIBeenPwendPolicy'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/HaveIBeenPwendPolicy'
tags:
- policies
parameters: []
/policies/haveibeenpwned/{policy_uuid}/:
get:
operationId: policies_haveibeenpwned_read
description: Source Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/HaveIBeenPwendPolicy'
tags:
- policies
put:
operationId: policies_haveibeenpwned_update
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/HaveIBeenPwendPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/HaveIBeenPwendPolicy'
tags:
- policies
patch:
operationId: policies_haveibeenpwned_partial_update
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/HaveIBeenPwendPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/HaveIBeenPwendPolicy'
tags:
- policies
delete:
operationId: policies_haveibeenpwned_delete
description: Source Viewset
parameters: []
responses:
'204':
description: ''
tags:
- policies
parameters:
- name: policy_uuid
in: path
description: A UUID string identifying this Have I Been Pwned Policy.
required: true
type: string
format: uuid
/policies/password/:
get:
operationId: policies_password_list
description: Password Policy Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PasswordPolicy'
tags:
- policies
post:
operationId: policies_password_create
description: Password Policy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordPolicy'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PasswordPolicy'
tags:
- policies
parameters: []
/policies/password/{policy_uuid}/:
get:
operationId: policies_password_read
description: Password Policy Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordPolicy'
tags:
- policies
put:
operationId: policies_password_update
description: Password Policy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordPolicy'
tags:
- policies
patch:
operationId: policies_password_partial_update
description: Password Policy Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordPolicy'
tags:
- policies
delete:
operationId: policies_password_delete
description: Password Policy Viewset
parameters: []
responses:
'204':
description: ''
tags:
- policies
parameters:
- name: policy_uuid
in: path
description: A UUID string identifying this Password Policy.
required: true
type: string
format: uuid
/policies/password_expiry/:
get:
operationId: policies_password_expiry_list
description: Password Expiry Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PasswordExpiryPolicy'
tags:
- policies
post:
operationId: policies_password_expiry_create
description: Password Expiry Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordExpiryPolicy'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PasswordExpiryPolicy'
tags:
- policies
parameters: []
/policies/password_expiry/{policy_uuid}/:
get:
operationId: policies_password_expiry_read
description: Password Expiry Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordExpiryPolicy'
tags:
- policies
put:
operationId: policies_password_expiry_update
description: Password Expiry Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordExpiryPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordExpiryPolicy'
tags:
- policies
patch:
operationId: policies_password_expiry_partial_update
description: Password Expiry Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordExpiryPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordExpiryPolicy'
tags:
- policies
delete:
operationId: policies_password_expiry_delete
description: Password Expiry Viewset
parameters: []
responses:
'204':
description: ''
tags:
- policies
parameters:
- name: policy_uuid
in: path
description: A UUID string identifying this Password Expiry Policy.
required: true
type: string
format: uuid
/policies/reputation/:
get:
operationId: policies_reputation_list
description: Source Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ReputationPolicy'
tags:
- policies
post:
operationId: policies_reputation_create
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ReputationPolicy'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ReputationPolicy'
tags:
- policies
parameters: []
/policies/reputation/{policy_uuid}/:
get:
operationId: policies_reputation_read
description: Source Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ReputationPolicy'
tags:
- policies
put:
operationId: policies_reputation_update
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ReputationPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ReputationPolicy'
tags:
- policies
patch:
operationId: policies_reputation_partial_update
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ReputationPolicy'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ReputationPolicy'
tags:
- policies
delete:
operationId: policies_reputation_delete
description: Source Viewset
parameters: []
responses:
'204':
description: ''
tags:
- policies
parameters:
- name: policy_uuid
in: path
description: A UUID string identifying this Reputation Policy.
required: true
type: string
format: uuid
/propertymappings/all/:
get:
operationId: propertymappings_all_list
description: PropertyMapping Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PropertyMapping'
tags:
- propertymappings
parameters: []
/propertymappings/all/{pm_uuid}/:
get:
operationId: propertymappings_all_read
description: PropertyMapping Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PropertyMapping'
tags:
- propertymappings
parameters:
- name: pm_uuid
in: path
description: A UUID string identifying this Property Mapping.
required: true
type: string
format: uuid
/propertymappings/ldap/:
get:
operationId: propertymappings_ldap_list
description: LDAP PropertyMapping Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/LDAPPropertyMapping'
tags:
- propertymappings
post:
operationId: propertymappings_ldap_create
description: LDAP PropertyMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/LDAPPropertyMapping'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/LDAPPropertyMapping'
tags:
- propertymappings
parameters: []
/propertymappings/ldap/{pm_uuid}/:
get:
operationId: propertymappings_ldap_read
description: LDAP PropertyMapping Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/LDAPPropertyMapping'
tags:
- propertymappings
put:
operationId: propertymappings_ldap_update
description: LDAP PropertyMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/LDAPPropertyMapping'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/LDAPPropertyMapping'
tags:
- propertymappings
patch:
operationId: propertymappings_ldap_partial_update
description: LDAP PropertyMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/LDAPPropertyMapping'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/LDAPPropertyMapping'
tags:
- propertymappings
delete:
operationId: propertymappings_ldap_delete
description: LDAP PropertyMapping Viewset
parameters: []
responses:
'204':
description: ''
tags:
- propertymappings
parameters:
- name: pm_uuid
in: path
description: A UUID string identifying this LDAP Property Mapping.
required: true
type: string
format: uuid
/propertymappings/saml/:
get:
operationId: propertymappings_saml_list
description: SAMLPropertyMapping Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/SAMLPropertyMapping'
tags:
- propertymappings
post:
operationId: propertymappings_saml_create
description: SAMLPropertyMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLPropertyMapping'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/SAMLPropertyMapping'
tags:
- propertymappings
parameters: []
/propertymappings/saml/{pm_uuid}/:
get:
operationId: propertymappings_saml_read
description: SAMLPropertyMapping Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLPropertyMapping'
tags:
- propertymappings
put:
operationId: propertymappings_saml_update
description: SAMLPropertyMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLPropertyMapping'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLPropertyMapping'
tags:
- propertymappings
patch:
operationId: propertymappings_saml_partial_update
description: SAMLPropertyMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLPropertyMapping'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLPropertyMapping'
tags:
- propertymappings
delete:
operationId: propertymappings_saml_delete
description: SAMLPropertyMapping Viewset
parameters: []
responses:
'204':
description: ''
tags:
- propertymappings
parameters:
- name: pm_uuid
in: path
description: A UUID string identifying this SAML Property Mapping.
required: true
type: string
format: uuid
/propertymappings/scope/:
get:
operationId: propertymappings_scope_list
description: ScopeMapping Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ScopeMapping'
tags:
- propertymappings
post:
operationId: propertymappings_scope_create
description: ScopeMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ScopeMapping'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ScopeMapping'
tags:
- propertymappings
parameters: []
/propertymappings/scope/{pm_uuid}/:
get:
operationId: propertymappings_scope_read
description: ScopeMapping Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ScopeMapping'
tags:
- propertymappings
put:
operationId: propertymappings_scope_update
description: ScopeMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ScopeMapping'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ScopeMapping'
tags:
- propertymappings
patch:
operationId: propertymappings_scope_partial_update
description: ScopeMapping Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ScopeMapping'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ScopeMapping'
tags:
- propertymappings
delete:
operationId: propertymappings_scope_delete
description: ScopeMapping Viewset
parameters: []
responses:
'204':
description: ''
tags:
- propertymappings
parameters:
- name: pm_uuid
in: path
description: A UUID string identifying this Scope Mapping.
required: true
type: string
format: uuid
/providers/all/:
get:
operationId: providers_all_list
description: Provider Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Provider'
tags:
- providers
parameters: []
/providers/all/{id}/:
get:
operationId: providers_all_read
description: Provider Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Provider'
tags:
- providers
parameters:
- name: id
in: path
description: A unique integer value identifying this provider.
required: true
type: integer
/providers/oauth2/:
get:
operationId: providers_oauth2_list
description: OAuth2Provider Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/OAuth2Provider'
tags:
- providers
post:
operationId: providers_oauth2_create
description: OAuth2Provider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OAuth2Provider'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/OAuth2Provider'
tags:
- providers
parameters: []
/providers/oauth2/{id}/:
get:
operationId: providers_oauth2_read
description: OAuth2Provider Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OAuth2Provider'
tags:
- providers
put:
operationId: providers_oauth2_update
description: OAuth2Provider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OAuth2Provider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OAuth2Provider'
tags:
- providers
patch:
operationId: providers_oauth2_partial_update
description: OAuth2Provider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OAuth2Provider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OAuth2Provider'
tags:
- providers
delete:
operationId: providers_oauth2_delete
description: OAuth2Provider Viewset
parameters: []
responses:
'204':
description: ''
tags:
- providers
parameters:
- name: id
in: path
description: A unique integer value identifying this OAuth2/OpenID Provider.
required: true
type: integer
/providers/proxy/:
get:
operationId: providers_proxy_list
description: ProxyProvider Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ProxyProvider'
tags:
- providers
post:
operationId: providers_proxy_create
description: ProxyProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ProxyProvider'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ProxyProvider'
tags:
- providers
parameters: []
/providers/proxy/{id}/:
get:
operationId: providers_proxy_read
description: ProxyProvider Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProxyProvider'
tags:
- providers
put:
operationId: providers_proxy_update
description: ProxyProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ProxyProvider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProxyProvider'
tags:
- providers
patch:
operationId: providers_proxy_partial_update
description: ProxyProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ProxyProvider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ProxyProvider'
tags:
- providers
delete:
operationId: providers_proxy_delete
description: ProxyProvider Viewset
parameters: []
responses:
'204':
description: ''
tags:
- providers
parameters:
- name: id
in: path
description: A unique integer value identifying this Proxy Provider.
required: true
type: integer
/providers/saml/:
get:
operationId: providers_saml_list
description: SAMLProvider Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/SAMLProvider'
tags:
- providers
post:
operationId: providers_saml_create
description: SAMLProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLProvider'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/SAMLProvider'
tags:
- providers
parameters: []
/providers/saml/{id}/:
get:
operationId: providers_saml_read
description: SAMLProvider Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLProvider'
tags:
- providers
put:
operationId: providers_saml_update
description: SAMLProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLProvider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLProvider'
tags:
- providers
patch:
operationId: providers_saml_partial_update
description: SAMLProvider Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLProvider'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLProvider'
tags:
- providers
delete:
operationId: providers_saml_delete
description: SAMLProvider Viewset
parameters: []
responses:
'204':
description: ''
tags:
- providers
parameters:
- name: id
in: path
description: A unique integer value identifying this SAML Provider.
required: true
type: integer
/root/messages/:
get:
operationId: root_messages_list
description: List current messages and pass into Serializer
parameters: []
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/Message'
tags:
- root
parameters: []
/sources/all/:
get:
operationId: sources_all_list
description: Source Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Source'
tags:
- sources
parameters: []
/sources/all/{pbm_uuid}/:
get:
operationId: sources_all_read
description: Source Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Source'
tags:
- sources
parameters:
- name: pbm_uuid
in: path
description: A UUID string identifying this source.
required: true
type: string
format: uuid
/sources/ldap/:
get:
operationId: sources_ldap_list
description: LDAP Source Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/LDAPSource'
tags:
- sources
post:
operationId: sources_ldap_create
description: LDAP Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/LDAPSource'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/LDAPSource'
tags:
- sources
parameters: []
/sources/ldap/{pbm_uuid}/:
get:
operationId: sources_ldap_read
description: LDAP Source Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/LDAPSource'
tags:
- sources
put:
operationId: sources_ldap_update
description: LDAP Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/LDAPSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/LDAPSource'
tags:
- sources
patch:
operationId: sources_ldap_partial_update
description: LDAP Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/LDAPSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/LDAPSource'
tags:
- sources
delete:
operationId: sources_ldap_delete
description: LDAP Source Viewset
parameters: []
responses:
'204':
description: ''
tags:
- sources
parameters:
- name: pbm_uuid
in: path
description: A UUID string identifying this LDAP Source.
required: true
type: string
format: uuid
/sources/oauth/:
get:
operationId: sources_oauth_list
description: Source Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/OAuthSource'
tags:
- sources
post:
operationId: sources_oauth_create
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OAuthSource'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/OAuthSource'
tags:
- sources
parameters: []
/sources/oauth/{pbm_uuid}/:
get:
operationId: sources_oauth_read
description: Source Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OAuthSource'
tags:
- sources
put:
operationId: sources_oauth_update
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OAuthSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OAuthSource'
tags:
- sources
patch:
operationId: sources_oauth_partial_update
description: Source Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OAuthSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OAuthSource'
tags:
- sources
delete:
operationId: sources_oauth_delete
description: Source Viewset
parameters: []
responses:
'204':
description: ''
tags:
- sources
parameters:
- name: pbm_uuid
in: path
description: A UUID string identifying this Generic OAuth Source.
required: true
type: string
format: uuid
/sources/saml/:
get:
operationId: sources_saml_list
description: SAMLSource Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/SAMLSource'
tags:
- sources
post:
operationId: sources_saml_create
description: SAMLSource Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLSource'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/SAMLSource'
tags:
- sources
parameters: []
/sources/saml/{pbm_uuid}/:
get:
operationId: sources_saml_read
description: SAMLSource Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLSource'
tags:
- sources
put:
operationId: sources_saml_update
description: SAMLSource Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLSource'
tags:
- sources
patch:
operationId: sources_saml_partial_update
description: SAMLSource Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/SAMLSource'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/SAMLSource'
tags:
- sources
delete:
operationId: sources_saml_delete
description: SAMLSource Viewset
parameters: []
responses:
'204':
description: ''
tags:
- sources
parameters:
- name: pbm_uuid
in: path
description: A UUID string identifying this SAML Source.
required: true
type: string
format: uuid
/stages/all/:
get:
operationId: stages_all_list
description: Stage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Stage'
tags:
- stages
parameters: []
/stages/all/{stage_uuid}/:
get:
operationId: stages_all_read
description: Stage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Stage'
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this stage.
required: true
type: string
format: uuid
/stages/captcha/:
get:
operationId: stages_captcha_list
description: CaptchaStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/CaptchaStage'
tags:
- stages
post:
operationId: stages_captcha_create
description: CaptchaStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CaptchaStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/CaptchaStage'
tags:
- stages
parameters: []
/stages/captcha/{stage_uuid}/:
get:
operationId: stages_captcha_read
description: CaptchaStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CaptchaStage'
tags:
- stages
put:
operationId: stages_captcha_update
description: CaptchaStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CaptchaStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CaptchaStage'
tags:
- stages
patch:
operationId: stages_captcha_partial_update
description: CaptchaStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/CaptchaStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/CaptchaStage'
tags:
- stages
delete:
operationId: stages_captcha_delete
description: CaptchaStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this Captcha Stage.
required: true
type: string
format: uuid
/stages/consent/:
get:
operationId: stages_consent_list
description: ConsentStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/ConsentStage'
tags:
- stages
post:
operationId: stages_consent_create
description: ConsentStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ConsentStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/ConsentStage'
tags:
- stages
parameters: []
/stages/consent/{stage_uuid}/:
get:
operationId: stages_consent_read
description: ConsentStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsentStage'
tags:
- stages
put:
operationId: stages_consent_update
description: ConsentStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ConsentStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsentStage'
tags:
- stages
patch:
operationId: stages_consent_partial_update
description: ConsentStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/ConsentStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/ConsentStage'
tags:
- stages
delete:
operationId: stages_consent_delete
description: ConsentStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this Consent Stage.
required: true
type: string
format: uuid
/stages/dummy/:
get:
operationId: stages_dummy_list
description: DummyStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/DummyStage'
tags:
- stages
post:
operationId: stages_dummy_create
description: DummyStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/DummyStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/DummyStage'
tags:
- stages
parameters: []
/stages/dummy/{stage_uuid}/:
get:
operationId: stages_dummy_read
description: DummyStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DummyStage'
tags:
- stages
put:
operationId: stages_dummy_update
description: DummyStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/DummyStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DummyStage'
tags:
- stages
patch:
operationId: stages_dummy_partial_update
description: DummyStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/DummyStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/DummyStage'
tags:
- stages
delete:
operationId: stages_dummy_delete
description: DummyStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this Dummy Stage.
required: true
type: string
format: uuid
/stages/email/:
get:
operationId: stages_email_list
description: EmailStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/EmailStage'
tags:
- stages
post:
operationId: stages_email_create
description: EmailStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/EmailStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/EmailStage'
tags:
- stages
parameters: []
/stages/email/{stage_uuid}/:
get:
operationId: stages_email_read
description: EmailStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/EmailStage'
tags:
- stages
put:
operationId: stages_email_update
description: EmailStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/EmailStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/EmailStage'
tags:
- stages
patch:
operationId: stages_email_partial_update
description: EmailStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/EmailStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/EmailStage'
tags:
- stages
delete:
operationId: stages_email_delete
description: EmailStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this Email Stage.
required: true
type: string
format: uuid
/stages/identification/:
get:
operationId: stages_identification_list
description: IdentificationStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/IdentificationStage'
tags:
- stages
post:
operationId: stages_identification_create
description: IdentificationStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/IdentificationStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/IdentificationStage'
tags:
- stages
parameters: []
/stages/identification/{stage_uuid}/:
get:
operationId: stages_identification_read
description: IdentificationStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IdentificationStage'
tags:
- stages
put:
operationId: stages_identification_update
description: IdentificationStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/IdentificationStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IdentificationStage'
tags:
- stages
patch:
operationId: stages_identification_partial_update
description: IdentificationStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/IdentificationStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/IdentificationStage'
tags:
- stages
delete:
operationId: stages_identification_delete
description: IdentificationStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this Identification Stage.
required: true
type: string
format: uuid
/stages/invitation/:
get:
operationId: stages_invitation_list
description: InvitationStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/InvitationStage'
tags:
- stages
post:
operationId: stages_invitation_create
description: InvitationStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/InvitationStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/InvitationStage'
tags:
- stages
parameters: []
/stages/invitation/invitations/:
get:
operationId: stages_invitation_invitations_list
description: Invitation Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Invitation'
tags:
- stages
post:
operationId: stages_invitation_invitations_create
description: Invitation Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Invitation'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Invitation'
tags:
- stages
parameters: []
/stages/invitation/invitations/{invite_uuid}/:
get:
operationId: stages_invitation_invitations_read
description: Invitation Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Invitation'
tags:
- stages
put:
operationId: stages_invitation_invitations_update
description: Invitation Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Invitation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Invitation'
tags:
- stages
patch:
operationId: stages_invitation_invitations_partial_update
description: Invitation Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Invitation'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Invitation'
tags:
- stages
delete:
operationId: stages_invitation_invitations_delete
description: Invitation Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: invite_uuid
in: path
description: A UUID string identifying this Invitation.
required: true
type: string
format: uuid
/stages/invitation/{stage_uuid}/:
get:
operationId: stages_invitation_read
description: InvitationStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InvitationStage'
tags:
- stages
put:
operationId: stages_invitation_update
description: InvitationStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/InvitationStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InvitationStage'
tags:
- stages
patch:
operationId: stages_invitation_partial_update
description: InvitationStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/InvitationStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/InvitationStage'
tags:
- stages
delete:
operationId: stages_invitation_delete
description: InvitationStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this Invitation Stage.
required: true
type: string
format: uuid
/stages/otp_static/:
get:
operationId: stages_otp_static_list
description: OTPStaticStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/OTPStaticStage'
tags:
- stages
post:
operationId: stages_otp_static_create
description: OTPStaticStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPStaticStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/OTPStaticStage'
tags:
- stages
parameters: []
/stages/otp_static/{stage_uuid}/:
get:
operationId: stages_otp_static_read
description: OTPStaticStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPStaticStage'
tags:
- stages
put:
operationId: stages_otp_static_update
description: OTPStaticStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPStaticStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPStaticStage'
tags:
- stages
patch:
operationId: stages_otp_static_partial_update
description: OTPStaticStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPStaticStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPStaticStage'
tags:
- stages
delete:
operationId: stages_otp_static_delete
description: OTPStaticStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this OTP Static Setup Stage.
required: true
type: string
format: uuid
/stages/otp_time/:
get:
operationId: stages_otp_time_list
description: OTPTimeStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/OTPTimeStage'
tags:
- stages
post:
operationId: stages_otp_time_create
description: OTPTimeStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPTimeStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/OTPTimeStage'
tags:
- stages
parameters: []
/stages/otp_time/{stage_uuid}/:
get:
operationId: stages_otp_time_read
description: OTPTimeStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPTimeStage'
tags:
- stages
put:
operationId: stages_otp_time_update
description: OTPTimeStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPTimeStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPTimeStage'
tags:
- stages
patch:
operationId: stages_otp_time_partial_update
description: OTPTimeStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPTimeStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPTimeStage'
tags:
- stages
delete:
operationId: stages_otp_time_delete
description: OTPTimeStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this OTP Time (TOTP) Setup Stage.
required: true
type: string
format: uuid
/stages/otp_validate/:
get:
operationId: stages_otp_validate_list
description: OTPValidateStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/OTPValidateStage'
tags:
- stages
post:
operationId: stages_otp_validate_create
description: OTPValidateStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPValidateStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/OTPValidateStage'
tags:
- stages
parameters: []
/stages/otp_validate/{stage_uuid}/:
get:
operationId: stages_otp_validate_read
description: OTPValidateStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPValidateStage'
tags:
- stages
put:
operationId: stages_otp_validate_update
description: OTPValidateStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPValidateStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPValidateStage'
tags:
- stages
patch:
operationId: stages_otp_validate_partial_update
description: OTPValidateStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/OTPValidateStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/OTPValidateStage'
tags:
- stages
delete:
operationId: stages_otp_validate_delete
description: OTPValidateStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this OTP Validation Stage.
required: true
type: string
format: uuid
/stages/password/:
get:
operationId: stages_password_list
description: PasswordStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PasswordStage'
tags:
- stages
post:
operationId: stages_password_create
description: PasswordStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PasswordStage'
tags:
- stages
parameters: []
/stages/password/{stage_uuid}/:
get:
operationId: stages_password_read
description: PasswordStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordStage'
tags:
- stages
put:
operationId: stages_password_update
description: PasswordStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordStage'
tags:
- stages
patch:
operationId: stages_password_partial_update
description: PasswordStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PasswordStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PasswordStage'
tags:
- stages
delete:
operationId: stages_password_delete
description: PasswordStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this Password Stage.
required: true
type: string
format: uuid
/stages/prompt/prompts/:
get:
operationId: stages_prompt_prompts_list
description: Prompt Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/Prompt'
tags:
- stages
post:
operationId: stages_prompt_prompts_create
description: Prompt Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Prompt'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/Prompt'
tags:
- stages
parameters: []
/stages/prompt/prompts/{prompt_uuid}/:
get:
operationId: stages_prompt_prompts_read
description: Prompt Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Prompt'
tags:
- stages
put:
operationId: stages_prompt_prompts_update
description: Prompt Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Prompt'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Prompt'
tags:
- stages
patch:
operationId: stages_prompt_prompts_partial_update
description: Prompt Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/Prompt'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/Prompt'
tags:
- stages
delete:
operationId: stages_prompt_prompts_delete
description: Prompt Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: prompt_uuid
in: path
description: A UUID string identifying this Prompt.
required: true
type: string
format: uuid
/stages/prompt/stages/:
get:
operationId: stages_prompt_stages_list
description: PromptStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/PromptStage'
tags:
- stages
post:
operationId: stages_prompt_stages_create
description: PromptStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PromptStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/PromptStage'
tags:
- stages
parameters: []
/stages/prompt/stages/{stage_uuid}/:
get:
operationId: stages_prompt_stages_read
description: PromptStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PromptStage'
tags:
- stages
put:
operationId: stages_prompt_stages_update
description: PromptStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PromptStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PromptStage'
tags:
- stages
patch:
operationId: stages_prompt_stages_partial_update
description: PromptStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/PromptStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/PromptStage'
tags:
- stages
delete:
operationId: stages_prompt_stages_delete
description: PromptStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this Prompt Stage.
required: true
type: string
format: uuid
/stages/user_delete/:
get:
operationId: stages_user_delete_list
description: UserDeleteStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/UserDeleteStage'
tags:
- stages
post:
operationId: stages_user_delete_create
description: UserDeleteStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserDeleteStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/UserDeleteStage'
tags:
- stages
parameters: []
/stages/user_delete/{stage_uuid}/:
get:
operationId: stages_user_delete_read
description: UserDeleteStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserDeleteStage'
tags:
- stages
put:
operationId: stages_user_delete_update
description: UserDeleteStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserDeleteStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserDeleteStage'
tags:
- stages
patch:
operationId: stages_user_delete_partial_update
description: UserDeleteStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserDeleteStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserDeleteStage'
tags:
- stages
delete:
operationId: stages_user_delete_delete
description: UserDeleteStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this User Delete Stage.
required: true
type: string
format: uuid
/stages/user_login/:
get:
operationId: stages_user_login_list
description: UserLoginStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/UserLoginStage'
tags:
- stages
post:
operationId: stages_user_login_create
description: UserLoginStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserLoginStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/UserLoginStage'
tags:
- stages
parameters: []
/stages/user_login/{stage_uuid}/:
get:
operationId: stages_user_login_read
description: UserLoginStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserLoginStage'
tags:
- stages
put:
operationId: stages_user_login_update
description: UserLoginStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserLoginStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserLoginStage'
tags:
- stages
patch:
operationId: stages_user_login_partial_update
description: UserLoginStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserLoginStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserLoginStage'
tags:
- stages
delete:
operationId: stages_user_login_delete
description: UserLoginStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this User Login Stage.
required: true
type: string
format: uuid
/stages/user_logout/:
get:
operationId: stages_user_logout_list
description: UserLogoutStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/UserLogoutStage'
tags:
- stages
post:
operationId: stages_user_logout_create
description: UserLogoutStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserLogoutStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/UserLogoutStage'
tags:
- stages
parameters: []
/stages/user_logout/{stage_uuid}/:
get:
operationId: stages_user_logout_read
description: UserLogoutStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserLogoutStage'
tags:
- stages
put:
operationId: stages_user_logout_update
description: UserLogoutStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserLogoutStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserLogoutStage'
tags:
- stages
patch:
operationId: stages_user_logout_partial_update
description: UserLogoutStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserLogoutStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserLogoutStage'
tags:
- stages
delete:
operationId: stages_user_logout_delete
description: UserLogoutStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this User Logout Stage.
required: true
type: string
format: uuid
/stages/user_write/:
get:
operationId: stages_user_write_list
description: UserWriteStage Viewset
parameters:
- name: ordering
in: query
description: Which field to use when ordering the results.
required: false
type: string
- name: search
in: query
description: A search term.
required: false
type: string
- name: limit
in: query
description: Number of results to return per page.
required: false
type: integer
- name: offset
in: query
description: The initial index from which to return the results.
required: false
type: integer
responses:
'200':
description: ''
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type: string
format: uri
x-nullable: true
previous:
type: string
format: uri
x-nullable: true
results:
type: array
items:
$ref: '#/definitions/UserWriteStage'
tags:
- stages
post:
operationId: stages_user_write_create
description: UserWriteStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserWriteStage'
responses:
'201':
description: ''
schema:
$ref: '#/definitions/UserWriteStage'
tags:
- stages
parameters: []
/stages/user_write/{stage_uuid}/:
get:
operationId: stages_user_write_read
description: UserWriteStage Viewset
parameters: []
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserWriteStage'
tags:
- stages
put:
operationId: stages_user_write_update
description: UserWriteStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserWriteStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserWriteStage'
tags:
- stages
patch:
operationId: stages_user_write_partial_update
description: UserWriteStage Viewset
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/UserWriteStage'
responses:
'200':
description: ''
schema:
$ref: '#/definitions/UserWriteStage'
tags:
- stages
delete:
operationId: stages_user_write_delete
description: UserWriteStage Viewset
parameters: []
responses:
'204':
description: ''
tags:
- stages
parameters:
- name: stage_uuid
in: path
description: A UUID string identifying this User Write Stage.
required: true
type: string
format: uuid
definitions:
Event:
required:
- action
- app
type: object
properties:
pk:
title: Event uuid
type: string
format: uuid
readOnly: true
user:
title: User
type: string
action:
title: Action
type: string
enum:
- LOGIN
- LOGIN_FAILED
- LOGOUT
- AUTHORIZE_APPLICATION
- SUSPICIOUS_REQUEST
- SIGN_UP
- PASSWORD_RESET
- INVITE_CREATED
- INVITE_USED
- IMPERSONATION_STARTED
- IMPERSONATION_ENDED
- CUSTOM
date:
title: Date
type: string
format: date-time
readOnly: true
app:
title: App
type: string
minLength: 1
context:
title: Context
type: string
client_ip:
title: Client ip
type: string
minLength: 1
x-nullable: true
created:
title: Created
type: string
format: date-time
readOnly: true
Application:
required:
- name
- slug
type: object
properties:
pk:
title: Pbm uuid
type: string
format: uuid
readOnly: true
name:
title: Name
description: Application's display Name.
type: string
minLength: 1
slug:
title: Slug
description: Internal application name, used in URLs.
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 50
minLength: 1
provider:
title: Provider
type: integer
x-nullable: true
meta_launch_url:
title: Meta launch url
type: string
format: uri
maxLength: 200
meta_icon_url:
title: Meta icon url
type: string
meta_description:
title: Meta description
type: string
meta_publisher:
title: Meta publisher
type: string
policies:
type: array
items:
type: string
format: uuid
readOnly: true
uniqueItems: true
Group:
required:
- name
- parent
- users
type: object
properties:
pk:
title: Group uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
maxLength: 80
minLength: 1
is_superuser:
title: Is superuser
description: Users added to this group will be superusers.
type: boolean
parent:
title: Parent
type: string
format: uuid
users:
type: array
items:
type: integer
uniqueItems: true
attributes:
title: Attributes
type: string
User:
required:
- username
- name
type: object
properties:
pk:
title: ID
type: integer
readOnly: true
username:
title: Username
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
only.
type: string
pattern: ^[\w.@+-]+$
maxLength: 150
minLength: 1
name:
title: Name
description: User's display name.
type: string
minLength: 1
is_superuser:
title: Is superuser
type: boolean
readOnly: true
email:
title: Email address
type: string
format: email
maxLength: 254
CertificateKeyPair:
required:
- name
- certificate_data
type: object
properties:
pk:
title: Kp uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
certificate_data:
title: Certificate data
description: PEM-encoded Certificate data
type: string
minLength: 1
key_data:
title: Key data
description: Optional Private Key. If this is set, you can use this keypair
for encryption.
type: string
FlowStageBinding:
required:
- target
- stage
- order
type: object
properties:
pk:
title: Fsb uuid
type: string
format: uuid
readOnly: true
target:
title: Target
type: string
format: uuid
stage:
title: Stage
type: string
format: uuid
re_evaluate_policies:
title: Re evaluate policies
description: When this option is enabled, the planner will re-evaluate policies
bound to this.
type: boolean
order:
title: Order
type: integer
maximum: 2147483647
minimum: -2147483648
policies:
type: array
items:
type: string
format: uuid
readOnly: true
uniqueItems: true
Flow:
required:
- name
- slug
- title
- designation
type: object
properties:
pk:
title: Flow uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
slug:
title: Slug
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 50
minLength: 1
title:
title: Title
type: string
minLength: 1
designation:
title: Designation
type: string
enum:
- authentication
- authorization
- invalidation
- enrollment
- unenrollment
- recovery
- stage_setup
stages:
type: array
items:
type: string
format: uuid
readOnly: true
uniqueItems: true
policies:
type: array
items:
type: string
format: uuid
readOnly: true
uniqueItems: true
Outpost:
required:
- name
- providers
- _config
type: object
properties:
pk:
title: Uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
providers:
type: array
items:
type: integer
uniqueItems: true
_config:
title: config
type: object
OpenIDConnectConfiguration:
title: Oidc configuration
description: Embed OpenID Connect provider information
required:
- issuer
- authorization_endpoint
- token_endpoint
- userinfo_endpoint
- end_session_endpoint
- introspection_endpoint
- jwks_uri
- response_types_supported
- id_token_signing_alg_values_supported
- subject_types_supported
- token_endpoint_auth_methods_supported
type: object
properties:
issuer:
title: Issuer
type: string
minLength: 1
authorization_endpoint:
title: Authorization endpoint
type: string
minLength: 1
token_endpoint:
title: Token endpoint
type: string
minLength: 1
userinfo_endpoint:
title: Userinfo endpoint
type: string
minLength: 1
end_session_endpoint:
title: End session endpoint
type: string
minLength: 1
introspection_endpoint:
title: Introspection endpoint
type: string
minLength: 1
jwks_uri:
title: Jwks uri
type: string
minLength: 1
response_types_supported:
type: array
items:
type: string
minLength: 1
id_token_signing_alg_values_supported:
type: array
items:
type: string
minLength: 1
subject_types_supported:
type: array
items:
type: string
minLength: 1
token_endpoint_auth_methods_supported:
type: array
items:
type: string
minLength: 1
ProxyOutpostConfig:
required:
- name
- internal_host
- external_host
type: object
properties:
pk:
title: ID
type: integer
readOnly: true
name:
title: Name
type: string
minLength: 1
internal_host:
title: Internal host
type: string
minLength: 1
external_host:
title: External host
type: string
minLength: 1
client_id:
title: Client ID
type: string
maxLength: 255
minLength: 1
client_secret:
title: Client Secret
type: string
maxLength: 255
oidc_configuration:
$ref: '#/definitions/OpenIDConnectConfiguration'
cookie_secret:
title: Cookie secret
type: string
minLength: 1
certificate:
title: Certificate
type: string
format: uuid
x-nullable: true
skip_path_regex:
title: Skip path regex
description: Regular expression for which authentication is not required.
Each new line is interpreted as a new Regular Expression.
type: string
Policy:
type: object
properties:
pk:
title: Policy uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
x-nullable: true
__type__:
title: 'type '
type: string
readOnly: true
PolicyBinding:
required:
- policy
- target
- order
type: object
properties:
pk:
title: Policy binding uuid
type: string
format: uuid
readOnly: true
policy:
title: Policy
type: string
format: uuid
target:
title: Target
type: string
format: uuid
enabled:
title: Enabled
type: boolean
order:
title: Order
type: integer
maximum: 2147483647
minimum: -2147483648
timeout:
title: Timeout
description: Timeout after which Policy execution is terminated.
type: integer
maximum: 2147483647
minimum: -2147483648
DummyPolicy:
type: object
properties:
pk:
title: Policy uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
x-nullable: true
result:
title: Result
type: boolean
wait_min:
title: Wait min
type: integer
maximum: 2147483647
minimum: -2147483648
wait_max:
title: Wait max
type: integer
maximum: 2147483647
minimum: -2147483648
ExpressionPolicy:
required:
- expression
type: object
properties:
pk:
title: Policy uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
x-nullable: true
expression:
title: Expression
type: string
minLength: 1
GroupMembershipPolicy:
type: object
properties:
pk:
title: Policy uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
x-nullable: true
group:
title: Group
type: string
format: uuid
x-nullable: true
HaveIBeenPwendPolicy:
type: object
properties:
pk:
title: Policy uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
x-nullable: true
password_field:
title: Password field
description: Field key to check, field keys defined in Prompt stages are available.
type: string
minLength: 1
allowed_count:
title: Allowed count
type: integer
maximum: 2147483647
minimum: -2147483648
PasswordPolicy:
required:
- error_message
type: object
properties:
pk:
title: Policy uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
x-nullable: true
password_field:
title: Password field
description: Field key to check, field keys defined in Prompt stages are available.
type: string
minLength: 1
amount_uppercase:
title: Amount uppercase
type: integer
maximum: 2147483647
minimum: -2147483648
amount_lowercase:
title: Amount lowercase
type: integer
maximum: 2147483647
minimum: -2147483648
amount_symbols:
title: Amount symbols
type: integer
maximum: 2147483647
minimum: -2147483648
length_min:
title: Length min
type: integer
maximum: 2147483647
minimum: -2147483648
symbol_charset:
title: Symbol charset
type: string
minLength: 1
error_message:
title: Error message
type: string
minLength: 1
PasswordExpiryPolicy:
required:
- days
type: object
properties:
pk:
title: Policy uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
x-nullable: true
days:
title: Days
type: integer
maximum: 2147483647
minimum: -2147483648
deny_only:
title: Deny only
type: boolean
ReputationPolicy:
type: object
properties:
pk:
title: Policy uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
x-nullable: true
check_ip:
title: Check ip
type: boolean
check_username:
title: Check username
type: boolean
threshold:
title: Threshold
type: integer
maximum: 2147483647
minimum: -2147483648
PropertyMapping:
required:
- name
- expression
type: object
properties:
pk:
title: Pm uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
expression:
title: Expression
type: string
minLength: 1
__type__:
title: 'type '
type: string
readOnly: true
LDAPPropertyMapping:
required:
- name
- expression
- object_field
type: object
properties:
pk:
title: Pm uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
expression:
title: Expression
type: string
minLength: 1
object_field:
title: Object field
type: string
minLength: 1
SAMLPropertyMapping:
required:
- name
- saml_name
- expression
type: object
properties:
pk:
title: Pm uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
saml_name:
title: SAML Name
type: string
minLength: 1
friendly_name:
title: Friendly name
type: string
x-nullable: true
expression:
title: Expression
type: string
minLength: 1
ScopeMapping:
required:
- name
- scope_name
- expression
type: object
properties:
pk:
title: Pm uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
scope_name:
title: Scope name
description: Scope used by the client
type: string
minLength: 1
description:
title: Description
description: Description shown to the user when consenting. If left empty,
the user won't be informed.
type: string
expression:
title: Expression
type: string
minLength: 1
Provider:
required:
- authorization_flow
type: object
properties:
pk:
title: ID
type: integer
readOnly: true
authorization_flow:
title: Authorization flow
description: Flow used when authorizing this provider.
type: string
format: uuid
property_mappings:
type: array
items:
type: string
format: uuid
uniqueItems: true
__type__:
title: 'type '
type: string
readOnly: true
OAuth2Provider:
required:
- name
- authorization_flow
type: object
properties:
pk:
title: ID
type: integer
readOnly: true
name:
title: Name
type: string
minLength: 1
authorization_flow:
title: Authorization flow
description: Flow used when authorizing this provider.
type: string
format: uuid
client_type:
title: Client Type
description: |-
Confidential clients are capable of maintaining the confidentiality
of their credentials. Public clients are incapable.
type: string
enum:
- confidential
- public
client_id:
title: Client ID
type: string
maxLength: 255
minLength: 1
client_secret:
title: Client Secret
type: string
maxLength: 255
response_type:
title: Response type
description: Response Type required by the client.
type: string
enum:
- code
- code#adfs
- id_token
- id_token token
- code token
- code id_token
- code id_token token
jwt_alg:
title: JWT Algorithm
description: Algorithm used to sign the JWT Token
type: string
enum:
- HS256
- RS256
rsa_key:
title: RSA Key
description: Key used to sign the tokens. Only required when JWT Algorithm
is set to RS256.
type: string
format: uuid
x-nullable: true
redirect_uris:
title: Redirect URIs
description: Enter each URI on a new line.
type: string
minLength: 1
sub_mode:
title: Sub mode
description: Configure what data should be used as unique User Identifier.
For most cases, the default should be fine.
type: string
enum:
- hashed_user_id
- user_username
- user_email
- user_upn
property_mappings:
type: array
items:
type: string
format: uuid
uniqueItems: true
ProxyProvider:
required:
- name
- internal_host
- external_host
type: object
properties:
pk:
title: ID
type: integer
readOnly: true
name:
title: Name
type: string
minLength: 1
internal_host:
title: Internal host
type: string
minLength: 1
external_host:
title: External host
type: string
minLength: 1
certificate:
title: Certificate
type: string
format: uuid
x-nullable: true
skip_path_regex:
title: Skip path regex
description: Regular expression for which authentication is not required.
Each new line is interpreted as a new Regular Expression.
type: string
SAMLProvider:
required:
- name
- acs_url
- issuer
type: object
properties:
pk:
title: ID
type: integer
readOnly: true
name:
title: Name
type: string
minLength: 1
acs_url:
title: ACS URL
type: string
format: uri
maxLength: 200
minLength: 1
audience:
title: Audience
type: string
minLength: 1
issuer:
title: Issuer
description: Also known as EntityID
type: string
minLength: 1
assertion_valid_not_before:
title: Assertion valid not before
description: 'Assertion valid not before current time + this value (Format:
hours=-1;minutes=-2;seconds=-3).'
type: string
minLength: 1
assertion_valid_not_on_or_after:
title: Assertion valid not on or after
description: 'Assertion not valid on or after current time + this value (Format:
hours=1;minutes=2;seconds=3).'
type: string
minLength: 1
session_valid_not_on_or_after:
title: Session valid not on or after
description: 'Session not valid on or after current time + this value (Format:
hours=1;minutes=2;seconds=3).'
type: string
minLength: 1
property_mappings:
type: array
items:
type: string
format: uuid
uniqueItems: true
digest_algorithm:
title: Digest algorithm
type: string
enum:
- sha1
- sha256
signature_algorithm:
title: Signature algorithm
type: string
enum:
- rsa-sha1
- rsa-sha256
- ecdsa-sha256
- dsa-sha1
signing_kp:
title: Signing Keypair
description: Singing is enabled upon selection of a Key Pair.
type: string
format: uuid
x-nullable: true
require_signing:
title: Require signing
description: Require Requests to be signed by an X509 Certificate. Must match
the Certificate selected in `Singing Keypair`.
type: boolean
Message:
type: object
properties:
message:
title: Message
type: string
readOnly: true
level:
title: Level
type: string
readOnly: true
tags:
title: Tags
type: string
readOnly: true
extra_tags:
title: Extra tags
type: string
readOnly: true
level_tag:
title: Level tag
type: string
readOnly: true
Source:
required:
- name
- slug
type: object
properties:
pk:
title: Pbm uuid
type: string
format: uuid
readOnly: true
name:
title: Name
description: Source's display Name.
type: string
minLength: 1
slug:
title: Slug
description: Internal source name, used in URLs.
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 50
minLength: 1
enabled:
title: Enabled
type: boolean
authentication_flow:
title: Authentication flow
description: Flow to use when authenticating existing users.
type: string
format: uuid
x-nullable: true
enrollment_flow:
title: Enrollment flow
description: Flow to use when enrolling new users.
type: string
format: uuid
x-nullable: true
__type__:
title: 'type '
type: string
readOnly: true
LDAPSource:
required:
- name
- slug
- server_uri
- bind_cn
- bind_password
- base_dn
type: object
properties:
pk:
title: Pbm uuid
type: string
format: uuid
readOnly: true
name:
title: Name
description: Source's display Name.
type: string
minLength: 1
slug:
title: Slug
description: Internal source name, used in URLs.
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 50
minLength: 1
enabled:
title: Enabled
type: boolean
authentication_flow:
title: Authentication flow
description: Flow to use when authenticating existing users.
type: string
format: uuid
x-nullable: true
enrollment_flow:
title: Enrollment flow
description: Flow to use when enrolling new users.
type: string
format: uuid
x-nullable: true
server_uri:
title: Server URI
type: string
minLength: 1
bind_cn:
title: Bind CN
type: string
minLength: 1
bind_password:
title: Bind password
type: string
minLength: 1
start_tls:
title: Enable Start TLS
type: boolean
base_dn:
title: Base DN
type: string
minLength: 1
additional_user_dn:
title: Addition User DN
description: Prepended to Base DN for User-queries.
type: string
additional_group_dn:
title: Addition Group DN
description: Prepended to Base DN for Group-queries.
type: string
user_object_filter:
title: User object filter
description: Consider Objects matching this filter to be Users.
type: string
minLength: 1
group_object_filter:
title: Group object filter
description: Consider Objects matching this filter to be Groups.
type: string
minLength: 1
user_group_membership_field:
title: User group membership field
description: Field which contains Groups of user.
type: string
minLength: 1
object_uniqueness_field:
title: Object uniqueness field
description: Field which contains a unique Identifier.
type: string
minLength: 1
sync_users:
title: Sync users
type: boolean
sync_users_password:
title: Sync users password
description: When a user changes their password, sync it back to LDAP. This
can only be enabled on a single LDAP source.
type: boolean
sync_groups:
title: Sync groups
type: boolean
sync_parent_group:
title: Sync parent group
type: string
format: uuid
x-nullable: true
property_mappings:
type: array
items:
type: string
format: uuid
uniqueItems: true
OAuthSource:
required:
- name
- slug
- provider_type
- authorization_url
- access_token_url
- profile_url
- consumer_key
- consumer_secret
type: object
properties:
pk:
title: Pbm uuid
type: string
format: uuid
readOnly: true
name:
title: Name
description: Source's display Name.
type: string
minLength: 1
slug:
title: Slug
description: Internal source name, used in URLs.
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 50
minLength: 1
enabled:
title: Enabled
type: boolean
authentication_flow:
title: Authentication flow
description: Flow to use when authenticating existing users.
type: string
format: uuid
x-nullable: true
enrollment_flow:
title: Enrollment flow
description: Flow to use when enrolling new users.
type: string
format: uuid
x-nullable: true
provider_type:
title: Provider type
type: string
maxLength: 255
minLength: 1
request_token_url:
title: Request Token URL
description: URL used to request the initial token. This URL is only required
for OAuth 1.
type: string
maxLength: 255
authorization_url:
title: Authorization URL
description: URL the user is redirect to to conest the flow.
type: string
maxLength: 255
minLength: 1
access_token_url:
title: Access Token URL
description: URL used by passbook to retrive tokens.
type: string
maxLength: 255
minLength: 1
profile_url:
title: Profile URL
description: URL used by passbook to get user information.
type: string
maxLength: 255
minLength: 1
consumer_key:
title: Consumer key
type: string
minLength: 1
consumer_secret:
title: Consumer secret
type: string
minLength: 1
SAMLSource:
required:
- name
- slug
- sso_url
- signing_kp
type: object
properties:
name:
title: Name
description: Source's display Name.
type: string
minLength: 1
slug:
title: Slug
description: Internal source name, used in URLs.
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 50
minLength: 1
enabled:
title: Enabled
type: boolean
authentication_flow:
title: Authentication flow
description: Flow to use when authenticating existing users.
type: string
format: uuid
x-nullable: true
enrollment_flow:
title: Enrollment flow
description: Flow to use when enrolling new users.
type: string
format: uuid
x-nullable: true
issuer:
title: Issuer
description: Also known as Entity ID. Defaults the Metadata URL.
type: string
sso_url:
title: SSO URL
description: URL that the initial Login request is sent to.
type: string
format: uri
maxLength: 200
minLength: 1
slo_url:
title: SLO URL
description: Optional URL if your IDP supports Single-Logout.
type: string
format: uri
maxLength: 200
x-nullable: true
allow_idp_initiated:
title: Allow idp initiated
description: Allows authentication flows initiated by the IdP. This can be
a security risk, as no validation of the request ID is done.
type: boolean
name_id_policy:
title: Name id policy
description: NameID Policy sent to the IdP. Can be unset, in which case no
Policy is sent.
type: string
enum:
- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
- urn:oasis:names:tc:SAML:2.0:nameid-format:X509SubjectName
- urn:oasis:names:tc:SAML:2.0:nameid-format:WindowsDomainQualifiedName
- urn:oasis:names:tc:SAML:2.0:nameid-format:transient
binding_type:
title: Binding type
type: string
enum:
- REDIRECT
- POST
- POST_AUTO
temporary_user_delete_after:
title: Delete temporary users after
description: "Time offset when temporary users should be deleted. This only\
\ applies if your IDP uses the NameID Format 'transient', and the user doesn't\
\ log out manually. (Format: hours=1;minutes=2;seconds=3)."
type: string
minLength: 1
signing_kp:
title: Singing Keypair
description: Certificate Key Pair of the IdP which Assertion's Signature is
validated against.
type: string
format: uuid
Stage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
__type__:
title: 'type '
type: string
readOnly: true
verbose_name:
title: Verbose name
type: string
readOnly: true
CaptchaStage:
required:
- name
- public_key
- private_key
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
public_key:
title: Public key
description: Public key, acquired from https://www.google.com/recaptcha/intro/v3.html
type: string
minLength: 1
private_key:
title: Private key
description: Private key, acquired from https://www.google.com/recaptcha/intro/v3.html
type: string
minLength: 1
ConsentStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
mode:
title: Mode
type: string
enum:
- always_require
- permanent
- expiring
consent_expire_in:
title: Consent expires in
description: 'Offset after which consent expires. (Format: hours=1;minutes=2;seconds=3).'
type: string
minLength: 1
DummyStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
EmailStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
host:
title: Host
type: string
minLength: 1
port:
title: Port
type: integer
maximum: 2147483647
minimum: -2147483648
username:
title: Username
type: string
password:
title: Password
type: string
use_tls:
title: Use tls
type: boolean
use_ssl:
title: Use ssl
type: boolean
timeout:
title: Timeout
type: integer
maximum: 2147483647
minimum: -2147483648
from_address:
title: From address
type: string
format: email
maxLength: 254
minLength: 1
token_expiry:
title: Token expiry
description: Time in minutes the token sent is valid.
type: integer
maximum: 2147483647
minimum: -2147483648
subject:
title: Subject
type: string
minLength: 1
template:
title: Template
type: string
enum:
- stages/email/for_email/password_reset.html
- stages/email/for_email/account_confirmation.html
IdentificationStage:
required:
- name
- user_fields
- template
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
user_fields:
description: Fields of the user object to match against.
type: array
items:
title: User fields
type: string
enum:
- email
- username
template:
title: Template
type: string
enum:
- stages/identification/login.html
- stages/identification/recovery.html
enrollment_flow:
title: Enrollment flow
description: Optional enrollment flow, which is linked at the bottom of the
page.
type: string
format: uuid
x-nullable: true
recovery_flow:
title: Recovery flow
description: Optional recovery flow, which is linked at the bottom of the
page.
type: string
format: uuid
x-nullable: true
InvitationStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
continue_flow_without_invitation:
title: Continue flow without invitation
description: If this flag is set, this Stage will jump to the next Stage when
no Invitation is given. By default this Stage will cancel the Flow when
no invitation is given.
type: boolean
Invitation:
type: object
properties:
pk:
title: Invite uuid
type: string
format: uuid
readOnly: true
expires:
title: Expires
type: string
format: date-time
x-nullable: true
fixed_data:
title: Fixed data
type: string
OTPStaticStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
token_count:
title: Token count
type: integer
maximum: 2147483647
minimum: -2147483648
OTPTimeStage:
required:
- name
- digits
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
digits:
title: Digits
type: integer
enum:
- 6
- 8
OTPValidateStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
PasswordStage:
required:
- name
- backends
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
backends:
description: Selection of backends to test the password against.
type: array
items:
title: Backends
type: string
minLength: 1
change_flow:
title: Change flow
description: Flow used by an authenticated user to change their password.
If empty, user will be unable to change their password.
type: string
format: uuid
x-nullable: true
failed_attempts_before_cancel:
title: Failed attempts before cancel
description: How many attempts a user has before the flow is canceled. To
lock the user out, use a reputation policy and a user_write stage.
type: integer
maximum: 2147483647
minimum: -2147483648
Prompt:
required:
- field_key
- label
- type
type: object
properties:
pk:
title: Prompt uuid
type: string
format: uuid
readOnly: true
field_key:
title: Field key
description: Name of the form field, also used to store the value
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
maxLength: 50
minLength: 1
label:
title: Label
type: string
minLength: 1
type:
title: Type
type: string
enum:
- text
- username
- email
- password
- number
- checkbox
- data
- data-time
- separator
- hidden
- static
required:
title: Required
type: boolean
placeholder:
title: Placeholder
type: string
order:
title: Order
type: integer
maximum: 2147483647
minimum: -2147483648
PromptStage:
required:
- name
- fields
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
fields:
type: array
items:
type: string
format: uuid
uniqueItems: true
validation_policies:
type: array
items:
type: string
format: uuid
uniqueItems: true
UserDeleteStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
UserLoginStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
session_duration:
title: Session duration
description: Determines how long a session lasts, in seconds. Default of 0
means that the sessions lasts until the browser is closed.
type: integer
maximum: 2147483647
minimum: 0
UserLogoutStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1
UserWriteStage:
required:
- name
type: object
properties:
pk:
title: Stage uuid
type: string
format: uuid
readOnly: true
name:
title: Name
type: string
minLength: 1