@itentialopensource/adapter-okta
Version:
This adapter integrates with system described as: okta.
1,922 lines • 397 kB
YAML
openapi: 3.0.0
info:
title: Okta API
description: Allows customers to easily access the Okta API
contact:
name: Okta Developer Team
url: http://developer.okta.com/
email: devex-public@okta.com
version: '2.4.0'
servers:
- url: https://your-subdomain.okta.com/
variables: {}
paths:
/api/v1/apps:
get:
tags:
- Application
summary: listApplications
description: Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.
operationId: listApplications
parameters:
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: after
in: query
description: Specifies the pagination cursor for the next page of apps
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Specifies the number of results for a page
style: form
explode: true
schema:
type: integer
format: int32
default: -1
- name: filter
in: query
description: Filters apps by status, user.id, group.id or credentials.signing.kid expression
style: form
explode: true
schema:
type: string
- name: expand
in: query
description: Traverses users link relationship and optionally embeds Application User resource
style: form
explode: true
schema:
type: string
- name: includeNonDeleted
in: query
description: ''
style: form
explode: true
schema:
type: boolean
default: false
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Application'
description: ''
deprecated: false
security:
- api_token: []
post:
tags:
- Application
summary: createApplication
description: Adds a new application to your Okta organization.
operationId: createApplication
parameters:
- name: activate
in: query
description: Executes activation lifecycle operation when creating the app
style: form
explode: true
schema:
type: boolean
default: true
- name: OktaAccessGateway-Agent
in: header
description: ''
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
required: true
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}:
delete:
tags:
- Application
summary: deleteApplication
description: Removes an inactive application.
operationId: deleteApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- Application
summary: getApplication
description: Fetches an application from your Okta organization by `id`.
operationId: getApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
deprecated: false
security:
- api_token: []
put:
tags:
- Application
summary: updateApplication
description: Updates an application in your organization.
operationId: updateApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
required: true
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/credentials/csrs:
get:
tags:
- Application
summary: listCsrsForApplication
description: Enumerates Certificate Signing Requests for an application
operationId: listCsrsForApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Csr'
description: ''
deprecated: false
security:
- api_token: []
post:
tags:
- Application
summary: generateCsrForApplication
description: Generates a new key pair and returns the Certificate Signing Request for it.
operationId: generateCsrForApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CsrMetadata'
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Csr'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/credentials/csrs/{csrId}:
delete:
tags:
- Application
summary: revokeCsrFromApplication
description: ''
operationId: revokeCsrFromApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: csrId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- Application
summary: getCsrForApplication
description: ''
operationId: getCsrForApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: csrId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Csr'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish:
post:
tags:
- Application
summary: ApiV1AppsCredentialsCsrsLifecyclePublish_POST
description: ''
operationId: ApiV1AppsCredentialsCsrsLifecyclePublish_POST
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: csrId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/JsonWebKey'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/credentials/keys:
get:
tags:
- Application
summary: listApplicationKeys
description: Enumerates key credentials for an application
operationId: listApplicationKeys
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/JsonWebKey'
description: ''
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/credentials/keys/generate:
post:
tags:
- Application
summary: generateApplicationKey
description: Generates a new X.509 certificate for an application key credential
operationId: generateApplicationKey
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: validityYears
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/JsonWebKey'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/credentials/keys/{keyId}:
get:
tags:
- Application
summary: getApplicationKey
description: Gets a specific application key credential by kid
operationId: getApplicationKey
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: keyId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/JsonWebKey'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/credentials/keys/{keyId}/clone:
post:
tags:
- Application
summary: cloneApplicationKey
description: Clones a X.509 certificate for an application key credential from a source application to target application.
operationId: cloneApplicationKey
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: keyId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: targetAid
in: query
description: Unique key of the target Application
required: true
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/JsonWebKey'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/grants:
get:
tags:
- Application
summary: listScopeConsentGrants
description: Lists all scope consent grants for the application
operationId: listScopeConsentGrants
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OAuth2ScopeConsentGrant'
description: ''
deprecated: false
security:
- api_token: []
post:
tags:
- Application
summary: grantConsentToScope
description: Grants consent for the application to request an OAuth 2.0 Okta scope
operationId: grantConsentToScope
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2ScopeConsentGrant'
required: true
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2ScopeConsentGrant'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/grants/{grantId}:
delete:
tags:
- Application
summary: revokeScopeConsentGrant
description: Revokes permission for the application to request the given scope
operationId: revokeScopeConsentGrant
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: grantId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- Application
summary: getScopeConsentGrant
description: Fetches a single scope consent grant for the application
operationId: getScopeConsentGrant
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: grantId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2ScopeConsentGrant'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/groups:
get:
tags:
- Application
summary: listApplicationGroupAssignments
description: Enumerates group assignments for an application.
operationId: listApplicationGroupAssignments
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: after
in: query
description: Specifies the pagination cursor for the next page of assignments
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Specifies the number of results for a page
style: form
explode: true
schema:
type: integer
format: int32
default: -1
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApplicationGroupAssignment'
description: ''
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/groups/{groupId}:
delete:
tags:
- Application
summary: deleteApplicationGroupAssignment
description: Removes a group assignment from an application.
operationId: deleteApplicationGroupAssignment
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: groupId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- Application
summary: getApplicationGroupAssignment
description: Fetches an application group assignment
operationId: getApplicationGroupAssignment
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: groupId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGroupAssignment'
deprecated: false
security:
- api_token: []
put:
tags:
- Application
summary: createApplicationGroupAssignment
description: Assigns a group to an application
operationId: createApplicationGroupAssignment
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: groupId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGroupAssignment'
required: false
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGroupAssignment'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/lifecycle/activate:
post:
tags:
- Application
summary: activateApplication
description: Activates an inactive application.
operationId: activateApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/lifecycle/deactivate:
post:
tags:
- Application
summary: deactivateApplication
description: Deactivates an active application.
operationId: deactivateApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/tokens:
delete:
tags:
- Application
summary: revokeOAuth2TokensForApplication
description: Revokes all tokens for the specified application
operationId: revokeOAuth2TokensForApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- Application
summary: listOAuth2TokensForApplication
description: Lists all tokens for the application
operationId: listOAuth2TokensForApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: after
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
default: 20
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OAuth2Token'
description: ''
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/tokens/{tokenId}:
delete:
tags:
- Application
summary: revokeOAuth2TokenForApplication
description: Revokes the specified token for the specified application
operationId: revokeOAuth2TokenForApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: tokenId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- Application
summary: getOAuth2TokenForApplication
description: Gets a token for the specified application
operationId: getOAuth2TokenForApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: tokenId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2Token'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/users:
get:
tags:
- Application
summary: listApplicationUsers
description: Enumerates all assigned [application users](#application-user-model) for an application.
operationId: listApplicationUsers
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: query_scope
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: after
in: query
description: specifies the pagination cursor for the next page of assignments
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: specifies the number of results for a page
style: form
explode: true
schema:
type: integer
format: int32
default: -1
- name: filter
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppUser'
description: ''
deprecated: false
security:
- api_token: []
post:
tags:
- Application
summary: assignUserToApplication
description: Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.
operationId: assignUserToApplication
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AppUser'
required: true
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppUser'
deprecated: false
security:
- api_token: []
/api/v1/apps/{appId}/users/{userId}:
delete:
tags:
- Application
summary: deleteApplicationUser
description: Removes an assignment for a user from an application.
operationId: deleteApplicationUser
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: userId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: sendEmail
in: query
description: ''
style: form
explode: true
schema:
type: boolean
default: false
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- Application
summary: getApplicationUser
description: Fetches a specific user assignment for application by `id`.
operationId: getApplicationUser
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: userId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppUser'
deprecated: false
security:
- api_token: []
post:
tags:
- Application
summary: updateApplicationUser
description: Updates a user's profile for an application
operationId: updateApplicationUser
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: userId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AppUser'
required: true
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AppUser'
deprecated: false
security:
- api_token: []
/api/v1/authorizationServers:
get:
tags:
- AuthorizationServer
summary: listAuthorizationServers
description: Success
operationId: listAuthorizationServers
parameters:
- name: q
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: after
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AuthorizationServer'
description: ''
deprecated: false
security:
- api_token: []
post:
tags:
- AuthorizationServer
summary: createAuthorizationServer
description: Success
operationId: createAuthorizationServer
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationServer'
required: true
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationServer'
'201':
description: Created
headers: {}
content: {}
deprecated: false
security:
- api_token: []
/api/v1/authorizationServers/{authServerId}:
delete:
tags:
- AuthorizationServer
summary: deleteAuthorizationServer
description: Success
operationId: deleteAuthorizationServer
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- AuthorizationServer
summary: getAuthorizationServer
description: Success
operationId: getAuthorizationServer
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationServer'
deprecated: false
security:
- api_token: []
put:
tags:
- AuthorizationServer
summary: updateAuthorizationServer
description: Success
operationId: updateAuthorizationServer
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationServer'
required: true
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationServer'
deprecated: false
security:
- api_token: []
/api/v1/authorizationServers/{authServerId}/claims:
get:
tags:
- AuthorizationServer
summary: listOAuth2Claims
description: Success
operationId: listOAuth2Claims
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OAuth2Claim'
description: ''
deprecated: false
security:
- api_token: []
post:
tags:
- AuthorizationServer
summary: createOAuth2Claim
description: Success
operationId: createOAuth2Claim
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2Claim'
required: true
responses:
'200':
description: Created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2Claim'
'201':
description: Success
headers: {}
content: {}
deprecated: false
security:
- api_token: []
/api/v1/authorizationServers/{authServerId}/claims/{claimId}:
delete:
tags:
- AuthorizationServer
summary: deleteOAuth2Claim
description: Success
operationId: deleteOAuth2Claim
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: claimId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- AuthorizationServer
summary: getOAuth2Claim
description: Success
operationId: getOAuth2Claim
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: claimId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2Claim'
deprecated: false
security:
- api_token: []
put:
tags:
- AuthorizationServer
summary: updateOAuth2Claim
description: Success
operationId: updateOAuth2Claim
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: claimId
in: path
description: ''
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2Claim'
required: true
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/OAuth2Claim'
deprecated: false
security:
- api_token: []
/api/v1/authorizationServers/{authServerId}/clients:
get:
tags:
- AuthorizationServer
summary: listOAuth2ClientsForAuthorizationServer
description: Success
operationId: listOAuth2ClientsForAuthorizationServer
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OAuth2Client'
description: ''
deprecated: false
security:
- api_token: []
/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens:
delete:
tags:
- AuthorizationServer
summary: revokeRefreshTokensForAuthorizationServerAndClient
description: Success
operationId: revokeRefreshTokensForAuthorizationServerAndClient
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: clientId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'204':
description: No Content
headers: {}
content: {}
deprecated: false
security:
- api_token: []
get:
tags:
- AuthorizationServer
summary: listRefreshTokensForAuthorizationServerAndClient
description: Success
operationId: listRefreshTokensForAuthorizationServerAndClient
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: clientId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: expand
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: after
in: query
description: ''
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: ''
style: form
explode: true
schema:
type: integer
format: int32
default: -1
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/OAuth2RefreshToken'
description: ''
deprecated: false
security:
- api_token: []
/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}:
delete:
tags:
- AuthorizationServer
summary: revokeRefreshTokenForAuthorizationServerAndClient
description: Success
operationId: revokeRefreshTokenForAuthorizationServerAndClient
parameters:
- name: authServerId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: clientId
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: tokenId
in: path
description: ''
required: true
style: simple
schema:
type: stri