UNPKG

@itentialopensource/adapter-okta

Version:

This adapter integrates with system described as: okta.

2,096 lines 490 kB
{ "swagger": "2.0", "info": { "title": "Okta API", "description": "Allows customers to easily access the Okta API", "termsOfService": "http://developer.okta.com/terms/", "contact": { "name": "Okta Developer Team", "email": "devex-public@okta.com", "url": "http://developer.okta.com/" }, "license": { "name": "Apache-2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "2.4.0" }, "externalDocs": { "description": "Find more info here", "url": "http://developer.okta.com/docs/api/getting_started/design_principles.html" }, "host": "your-subdomain.okta.com", "basePath": "/", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "api_token": { "description": "SSWS {API Token}", "in": "header", "name": "Authorization", "type": "apiKey" } }, "paths": { "/api/v1/apps": { "get": { "consumes": [ "application/json" ], "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": [ { "in": "query", "name": "q", "type": "string" }, { "description": "Specifies the pagination cursor for the next page of apps", "in": "query", "name": "after", "type": "string" }, { "default": -1, "description": "Specifies the number of results for a page", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "description": "Filters apps by status, user.id, group.id or credentials.signing.kid expression", "in": "query", "name": "filter", "type": "string" }, { "description": "Traverses users link relationship and optionally embeds Application User resource", "in": "query", "name": "expand", "type": "string" }, { "default": false, "in": "query", "name": "includeNonDeleted", "type": "boolean" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/Application" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "summary": "List Applications", "tags": [ "Application" ] }, "post": { "consumes": [ "application/json" ], "description": "Adds a new application to your Okta organization.", "operationId": "createApplication", "parameters": [ { "in": "body", "name": "application", "required": true, "schema": { "$ref": "#/definitions/Application" } }, { "default": true, "description": "Executes activation lifecycle operation when creating the app", "in": "query", "name": "activate", "type": "boolean" }, { "in": "header", "name": "OktaAccessGateway-Agent", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Application" } } }, "security": [ { "api_token": [] } ], "summary": "Add Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}": { "delete": { "consumes": [ "application/json" ], "description": "Removes an inactive application.", "operationId": "deleteApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success" } }, "security": [ { "api_token": [] } ], "summary": "Delete Application", "tags": [ "Application" ] }, "get": { "consumes": [ "application/json" ], "description": "Fetches an application from your Okta organization by `id`.", "operationId": "getApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "query", "name": "expand", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Application" } } }, "security": [ { "api_token": [] } ], "summary": "Get Application", "tags": [ "Application" ] }, "put": { "consumes": [ "application/json" ], "description": "Updates an application in your organization.", "operationId": "updateApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "body", "name": "application", "required": true, "schema": { "$ref": "#/definitions/Application" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Application" } } }, "security": [ { "api_token": [] } ], "summary": "Update Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/credentials/csrs": { "get": { "consumes": [ "application/json" ], "description": "Enumerates Certificate Signing Requests for an application", "operationId": "listCsrsForApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/Csr" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "summary": "List Certificate Signing Requests for Application", "tags": [ "Application" ] }, "post": { "consumes": [ "application/json" ], "description": "Generates a new key pair and returns the Certificate Signing Request for it.", "operationId": "generateCsrForApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "body", "name": "metadata", "required": true, "schema": { "$ref": "#/definitions/CsrMetadata" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Csr" } } }, "security": [ { "api_token": [] } ], "summary": "Generate Certificate Signing Request for Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/credentials/csrs/{csrId}": { "delete": { "consumes": [ "application/json" ], "operationId": "revokeCsrFromApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "csrId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] }, "get": { "consumes": [ "application/json" ], "operationId": "getCsrForApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "csrId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Csr" } } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish": { "post": { "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "csrId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/JsonWebKey" } } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ], "x-okta-multi-operation": [ { "consumes": [ "application/x-x509-ca-cert" ], "encoding": "base64", "operationId": "publishCerCert", "parameters": [ { "in": "body", "name": "certificate", "required": true, "type": "string" } ] }, { "consumes": [ "application/x-x509-ca-cert" ], "operationId": "publishBinaryCerCert", "parameters": [ { "format": "binary", "in": "body", "name": "certificate", "required": true, "type": "string" } ] }, { "consumes": [ "application/pkix-cert" ], "encoding": "base64", "operationId": "publishDerCert", "parameters": [ { "in": "body", "name": "certificate", "required": true, "type": "string" } ] }, { "consumes": [ "application/pkix-cert" ], "operationId": "publishBinaryDerCert", "parameters": [ { "format": "binary", "in": "body", "name": "certificate", "required": true, "type": "string" } ] }, { "consumes": [ "application/x-pem-file" ], "operationId": "publishBinaryPemCert", "parameters": [ { "format": "binary", "in": "body", "name": "certificate", "required": true, "type": "string" } ] } ] } }, "/api/v1/apps/{appId}/credentials/keys": { "get": { "consumes": [ "application/json" ], "description": "Enumerates key credentials for an application", "operationId": "listApplicationKeys", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/JsonWebKey" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "summary": "List Key Credentials for Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/credentials/keys/generate": { "post": { "consumes": [ "application/json" ], "description": "Generates a new X.509 certificate for an application key credential", "operationId": "generateApplicationKey", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "query", "name": "validityYears", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/JsonWebKey" } } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/credentials/keys/{keyId}": { "get": { "consumes": [ "application/json" ], "description": "Gets a specific application key credential by kid", "operationId": "getApplicationKey", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "keyId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/JsonWebKey" } } }, "security": [ { "api_token": [] } ], "summary": "Get Key Credential for Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/credentials/keys/{keyId}/clone": { "post": { "consumes": [ "application/json" ], "description": "Clones a X.509 certificate for an application key credential from a source application to target application.", "operationId": "cloneApplicationKey", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "keyId", "required": true, "type": "string" }, { "description": "Unique key of the target Application", "in": "query", "name": "targetAid", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/JsonWebKey" } } }, "security": [ { "api_token": [] } ], "summary": "Clone Application Key Credential", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/grants": { "get": { "consumes": [ "application/json" ], "description": "Lists all scope consent grants for the application", "operationId": "listScopeConsentGrants", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "query", "name": "expand", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/OAuth2ScopeConsentGrant" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] }, "post": { "consumes": [ "application/json" ], "description": "Grants consent for the application to request an OAuth 2.0 Okta scope", "operationId": "grantConsentToScope", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "body", "name": "oAuth2ScopeConsentGrant", "required": true, "schema": { "$ref": "#/definitions/OAuth2ScopeConsentGrant" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/OAuth2ScopeConsentGrant" } } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/grants/{grantId}": { "delete": { "consumes": [ "application/json" ], "description": "Revokes permission for the application to request the given scope", "operationId": "revokeScopeConsentGrant", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "grantId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] }, "get": { "consumes": [ "application/json" ], "description": "Fetches a single scope consent grant for the application", "operationId": "getScopeConsentGrant", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "grantId", "required": true, "type": "string" }, { "in": "query", "name": "expand", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OAuth2ScopeConsentGrant" } } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/groups": { "get": { "consumes": [ "application/json" ], "description": "Enumerates group assignments for an application.", "operationId": "listApplicationGroupAssignments", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "query", "name": "q", "type": "string" }, { "description": "Specifies the pagination cursor for the next page of assignments", "in": "query", "name": "after", "type": "string" }, { "default": -1, "description": "Specifies the number of results for a page", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "in": "query", "name": "expand", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/ApplicationGroupAssignment" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "summary": "List Groups Assigned to Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/groups/{groupId}": { "delete": { "consumes": [ "application/json" ], "description": "Removes a group assignment from an application.", "operationId": "deleteApplicationGroupAssignment", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "groupId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "summary": "Remove Group from Application", "tags": [ "Application" ] }, "get": { "consumes": [ "application/json" ], "description": "Fetches an application group assignment", "operationId": "getApplicationGroupAssignment", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "groupId", "required": true, "type": "string" }, { "in": "query", "name": "expand", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ApplicationGroupAssignment" } } }, "security": [ { "api_token": [] } ], "summary": "Get Assigned Group for Application", "tags": [ "Application" ] }, "put": { "consumes": [ "application/json" ], "description": "Assigns a group to an application", "operationId": "createApplicationGroupAssignment", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "groupId", "required": true, "type": "string" }, { "in": "body", "name": "applicationGroupAssignment", "schema": { "$ref": "#/definitions/ApplicationGroupAssignment" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ApplicationGroupAssignment" } } }, "security": [ { "api_token": [] } ], "summary": "Assign Group to Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/lifecycle/activate": { "post": { "consumes": [ "application/json" ], "description": "Activates an inactive application.", "operationId": "activateApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success" } }, "security": [ { "api_token": [] } ], "summary": "Activate Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/lifecycle/deactivate": { "post": { "consumes": [ "application/json" ], "description": "Deactivates an active application.", "operationId": "deactivateApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success" } }, "security": [ { "api_token": [] } ], "summary": "Deactivate Application", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/tokens": { "delete": { "consumes": [ "application/json" ], "description": "Revokes all tokens for the specified application", "operationId": "revokeOAuth2TokensForApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] }, "get": { "consumes": [ "application/json" ], "description": "Lists all tokens for the application", "operationId": "listOAuth2TokensForApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "query", "name": "expand", "type": "string" }, { "in": "query", "name": "after", "type": "string" }, { "default": 20, "format": "int32", "in": "query", "name": "limit", "type": "integer" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/OAuth2Token" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/tokens/{tokenId}": { "delete": { "consumes": [ "application/json" ], "description": "Revokes the specified token for the specified application", "operationId": "revokeOAuth2TokenForApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "tokenId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] }, "get": { "consumes": [ "application/json" ], "description": "Gets a token for the specified application", "operationId": "getOAuth2TokenForApplication", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "tokenId", "required": true, "type": "string" }, { "in": "query", "name": "expand", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OAuth2Token" } } }, "security": [ { "api_token": [] } ], "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/users": { "get": { "consumes": [ "application/json" ], "description": "Enumerates all assigned [application users](#application-user-model) for an application.", "operationId": "listApplicationUsers", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "query", "name": "q", "type": "string" }, { "in": "query", "name": "query_scope", "type": "string" }, { "description": "specifies the pagination cursor for the next page of assignments", "in": "query", "name": "after", "type": "string" }, { "default": -1, "description": "specifies the number of results for a page", "format": "int32", "in": "query", "name": "limit", "type": "integer" }, { "in": "query", "name": "filter", "type": "string" }, { "in": "query", "name": "expand", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/AppUser" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "summary": "List Users Assigned to Application", "tags": [ "Application" ] }, "post": { "consumes": [ "application/json" ], "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": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "body", "name": "appUser", "required": true, "schema": { "$ref": "#/definitions/AppUser" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AppUser" } } }, "security": [ { "api_token": [] } ], "summary": "Assign User to Application for SSO & Provisioning", "tags": [ "Application" ] } }, "/api/v1/apps/{appId}/users/{userId}": { "delete": { "consumes": [ "application/json" ], "description": "Removes an assignment for a user from an application.", "operationId": "deleteApplicationUser", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "userId", "required": true, "type": "string" }, { "default": false, "in": "query", "name": "sendEmail", "type": "boolean", "x-okta-added-version": "1.5.0" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "summary": "Remove User from Application", "tags": [ "Application" ] }, "get": { "consumes": [ "application/json" ], "description": "Fetches a specific user assignment for application by `id`.", "operationId": "getApplicationUser", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "userId", "required": true, "type": "string" }, { "in": "query", "name": "expand", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AppUser" } } }, "security": [ { "api_token": [] } ], "summary": "Get Assigned User for Application", "tags": [ "Application" ] }, "post": { "consumes": [ "application/json" ], "description": "Updates a user's profile for an application", "operationId": "updateApplicationUser", "parameters": [ { "in": "path", "name": "appId", "required": true, "type": "string" }, { "in": "path", "name": "userId", "required": true, "type": "string" }, { "in": "body", "name": "appUser", "required": true, "schema": { "$ref": "#/definitions/AppUser" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AppUser" } } }, "security": [ { "api_token": [] } ], "summary": "Update Application Profile for Assigned User", "tags": [ "Application" ] } }, "/api/v1/authorizationServers": { "get": { "consumes": [ "application/json" ], "description": "Success", "operationId": "listAuthorizationServers", "parameters": [ { "in": "query", "name": "q", "type": "string" }, { "in": "query", "name": "limit", "type": "string" }, { "in": "query", "name": "after", "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/AuthorizationServer" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] }, "post": { "consumes": [ "application/json" ], "description": "Success", "operationId": "createAuthorizationServer", "parameters": [ { "in": "body", "name": "authorizationServer", "required": true, "schema": { "$ref": "#/definitions/AuthorizationServer" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AuthorizationServer" } }, "201": { "description": "Created" } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] } }, "/api/v1/authorizationServers/{authServerId}": { "delete": { "consumes": [ "application/json" ], "description": "Success", "operationId": "deleteAuthorizationServer", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] }, "get": { "consumes": [ "application/json" ], "description": "Success", "operationId": "getAuthorizationServer", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AuthorizationServer" } } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] }, "put": { "consumes": [ "application/json" ], "description": "Success", "operationId": "updateAuthorizationServer", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" }, { "in": "body", "name": "authorizationServer", "required": true, "schema": { "$ref": "#/definitions/AuthorizationServer" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AuthorizationServer" } } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] } }, "/api/v1/authorizationServers/{authServerId}/claims": { "get": { "consumes": [ "application/json" ], "description": "Success", "operationId": "listOAuth2Claims", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/OAuth2Claim" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] }, "post": { "consumes": [ "application/json" ], "description": "Success", "operationId": "createOAuth2Claim", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" }, { "in": "body", "name": "oAuth2Claim", "required": true, "schema": { "$ref": "#/definitions/OAuth2Claim" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Created", "schema": { "$ref": "#/definitions/OAuth2Claim" } }, "201": { "description": "Success" } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] } }, "/api/v1/authorizationServers/{authServerId}/claims/{claimId}": { "delete": { "consumes": [ "application/json" ], "description": "Success", "operationId": "deleteOAuth2Claim", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" }, { "in": "path", "name": "claimId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] }, "get": { "consumes": [ "application/json" ], "description": "Success", "operationId": "getOAuth2Claim", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" }, { "in": "path", "name": "claimId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OAuth2Claim" } } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] }, "put": { "consumes": [ "application/json" ], "description": "Success", "operationId": "updateOAuth2Claim", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" }, { "in": "path", "name": "claimId", "required": true, "type": "string" }, { "in": "body", "name": "oAuth2Claim", "required": true, "schema": { "$ref": "#/definitions/OAuth2Claim" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OAuth2Claim" } } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] } }, "/api/v1/authorizationServers/{authServerId}/clients": { "get": { "consumes": [ "application/json" ], "description": "Success", "operationId": "listOAuth2ClientsForAuthorizationServer", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "items": { "$ref": "#/definitions/OAuth2Client" }, "type": "array" } } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] } }, "/api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens": { "delete": { "consumes": [ "application/json" ], "description": "Success", "operationId": "revokeRefreshTokensForAuthorizationServerAndClient", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" }, { "in": "path", "name": "clientId", "required": true, "type": "string" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" } }, "security": [ { "api_token": [] } ], "tags": [ "AuthorizationServer" ] }, "get": { "consumes": [ "application/json" ], "description": "Success", "operationId": "listRefreshTokensForAuthorizationServerAndClient", "parameters": [ { "in": "path", "name": "authServerId", "required": true, "type": "string" }, { "in": "path", "name": "clientId", "required":