@itentialopensource/adapter-okta
Version:
This adapter integrates with system described as: okta.
1,719 lines (1,718 loc) • 2.11 MB
JSON
{
"id": "@itentialopensource/adapter-okta",
"type": "Adapter",
"export": "Okta",
"title": "Okta",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [
{
"name": "maxCalls",
"required": false,
"type": "number",
"info": "How many GET endpoints to test (defaults to 5)",
"schema": {
"title": "maxCalls",
"type": "number",
"default": 5
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the Itential Platform database",
"description": "Moves entities from an adapter into the Itential Platform database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "listApplications",
"summary": "List Applications",
"description": "Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.",
"input": [
{
"name": "q",
"type": "string",
"info": ": string",
"required": false,
"schema": {
"title": "q",
"type": "string"
}
},
{
"name": "after",
"type": "string",
"info": "Specifies the pagination cursor for the next page of apps: string",
"required": false,
"schema": {
"title": "after",
"type": "string"
}
},
{
"name": "limit",
"type": "number",
"info": "Specifies the number of results for a page: 123",
"required": false,
"schema": {
"title": "limit",
"type": "number"
}
},
{
"name": "filter",
"type": "string",
"info": "Filters apps by status, user.id, group.id or credentials.signing.kid expression: string",
"required": false,
"schema": {
"title": "filter",
"type": "string"
}
},
{
"name": "expand",
"type": "string",
"info": "Traverses users link relationship and optionally embeds Application User resource: string",
"required": false,
"schema": {
"title": "expand",
"type": "string"
}
},
{
"name": "includeNonDeleted",
"type": "boolean",
"info": ": boolean",
"required": false,
"schema": {
"title": "includeNonDeleted",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"items": {
"properties": {
"_embedded": {
"additionalProperties": {
"type": "object"
},
"readOnly": true,
"type": "object"
},
"_links": {
"additionalProperties": {
"type": "object"
},
"readOnly": true,
"type": "object"
},
"accessibility": {
"properties": {
"errorRedirectUrl": {
"type": "string"
},
"loginRedirectUrl": {
"type": "string"
},
"selfService": {
"type": "boolean"
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
},
"created": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"credentials": {
"properties": {
"signing": {
"properties": {
"kid": {
"type": "string"
},
"lastRotated": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"nextRotation": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"rotationMode": {
"type": "string"
},
"use": {
"enum": [
"sig"
],
"type": "string",
"x-okta-tags": [
"AuthorizationServer"
]
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
},
"userNameTemplate": {
"properties": {
"suffix": {
"type": "string"
},
"template": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
},
"features": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"readOnly": true,
"type": "string"
},
"label": {
"type": "string"
},
"lastUpdated": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"licensing": {
"properties": {
"seatCount": {
"type": "integer"
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
},
"name": {
"readOnly": true,
"type": "string"
},
"profile": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"settings": {
"properties": {
"app": {
"x-okta-tags": [
"Application"
],
"type": "object"
},
"implicitAssignment": {
"type": "boolean"
},
"inlineHookId": {
"type": "string"
},
"notifications": {
"properties": {
"vpn": {
"properties": {
"helpUrl": {
"type": "string"
},
"message": {
"type": "string"
},
"network": {
"type": "object",
"description": ""
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
},
"signOnMode": {
"enum": [
"BOOKMARK",
"BASIC_AUTH",
"BROWSER_PLUGIN",
"SECURE_PASSWORD_STORE",
"AUTO_LOGIN",
"WS_FEDERATION",
"SAML_2_0",
"OPENID_CONNECT",
"SAML_1_1"
],
"type": "string",
"x-okta-tags": [
"Application"
]
},
"status": {
"enum": [
"ACTIVE",
"INACTIVE",
"DELETED"
],
"readOnly": true,
"type": "string"
},
"visibility": {
"properties": {
"appLinks": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"autoSubmitToolbar": {
"type": "boolean"
},
"hide": {
"properties": {
"iOS": {
"type": "boolean"
},
"web": {
"type": "boolean"
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
}
},
"type": "object",
"x-okta-crud": [
{
"alias": "read",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "getApplication"
},
{
"alias": "update",
"arguments": [
{
"dest": "appId",
"src": "id"
},
{
"dest": "application",
"self": true
}
],
"operationId": "updateApplication"
},
{
"alias": "delete",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "deleteApplication"
}
],
"x-okta-operations": [
{
"alias": "activate",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "activateApplication"
},
{
"alias": "deactivate",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "deactivateApplication"
},
{
"alias": "listApplicationUsers",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "listApplicationUsers"
},
{
"alias": "assignUserToApplication",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "assignUserToApplication"
},
{
"alias": "getApplicationUser",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "getApplicationUser"
},
{
"alias": "createApplicationGroupAssignment",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "createApplicationGroupAssignment"
},
{
"alias": "getApplicationGroupAssignment",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "getApplicationGroupAssignment"
},
{
"alias": "cloneApplicationKey",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "cloneApplicationKey"
},
{
"alias": "getApplicationKey",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "getApplicationKey"
},
{
"alias": "listGroupAssignments",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "listApplicationGroupAssignments"
},
{
"alias": "listKeys",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "listApplicationKeys"
},
{
"alias": "generateKey",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "generateApplicationKey"
},
{
"alias": "generateCsr",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "generateCsrForApplication"
},
{
"alias": "getCsr",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "getCsrForApplication"
},
{
"alias": "revokeCsr",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "revokeCsrFromApplication"
},
{
"alias": "listCsrs",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "listCsrsForApplication"
},
{
"alias": "publishCerCert",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "publishCerCert"
},
{
"alias": "publishBinaryCerCert",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "publishBinaryCerCert"
},
{
"alias": "publishDerCert",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "publishDerCert"
},
{
"alias": "publishBinaryDerCert",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "publishBinaryDerCert"
},
{
"alias": "publishBinaryPemCert",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "publishBinaryPemCert"
},
{
"alias": "listOAuth2Tokens",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "listOAuth2TokensForApplication"
},
{
"alias": "revokeOAuth2TokenForApplication",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "revokeOAuth2TokenForApplication"
},
{
"alias": "getOAuth2Token",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "getOAuth2TokenForApplication"
},
{
"alias": "revokeOAuth2Tokens",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "revokeOAuth2TokensForApplication"
},
{
"alias": "listScopeConsentGrants",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "listScopeConsentGrants"
},
{
"alias": "grantConsentToScope",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "grantConsentToScope"
},
{
"alias": "revokeScopeConsentGrant",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "revokeScopeConsentGrant"
},
{
"alias": "getScopeConsentGrant",
"arguments": [
{
"dest": "appId",
"src": "id"
}
],
"operationId": "getScopeConsentGrant"
}
],
"x-okta-tags": [
"Application"
],
"x-openapi-v3-discriminator": {
"mapping": {
"AUTO_LOGIN": "#/definitions/AutoLoginApplication",
"BASIC_AUTH": "#/definitions/BasicAuthApplication",
"BOOKMARK": "#/definitions/BookmarkApplication",
"BROWSER_PLUGIN": "#/definitions/BrowserPluginApplication",
"OPENID_CONNECT": "#/definitions/OpenIdConnectApplication",
"SAML_1_1": "#/definitions/SamlApplication",
"SAML_2_0": "#/definitions/SamlApplication",
"SECURE_PASSWORD_STORE": "#/definitions/SecurePasswordStoreApplication",
"WS_FEDERATION": "#/definitions/WsFederationApplication"
},
"propertyName": "signOnMode"
}
},
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/listApplications"
},
"task": true
},
{
"name": "createApplication",
"summary": "Add Application",
"description": "Adds a new application to your Okta organization.",
"input": [
{
"name": "application",
"type": "object",
"info": ": {\"_embedded\": \"object\", \"_links\": \"object\", \"accessibility\": {\"errorRedirectUrl\": \"string\", \"loginRedirectUrl\": \"string\", \"selfService\": \"boolean\"}, \"created\": \"string\", \"credentials\": {\"signing\": {\"kid\": \"string\", \"lastRotated\": \"string\", \"nextRotation\": \"string\", \"rotationMode\": \"string\", \"use\": \"Must be one of [sig]\"}, \"userNameTemplate\": {\"suffix\": \"string\", \"template\": \"string\", \"type\": \"string\"}}, \"features\": \"array\", \"id\": \"string\", \"label\": \"string\", \"lastUpdated\": \"string\", \"licensing\": {\"seatCount\": 123}, \"name\": \"string\", \"profile\": \"object\", \"settings\": {\"app\": \"object\", \"implicitAssignment\": \"boolean\", \"inlineHookId\": \"string\", \"notifications\": {\"vpn\": {\"helpUrl\": \"string\", \"message\": \"string\", \"network\": \"object\"}}}, \"signOnMode\": \"Must be one of [BOOKMARK, BASIC_AUTH, BROWSER_PLUGIN, SECURE_PASSWORD_STORE, AUTO_LOGIN, WS_FEDERATION, SAML_2_0, OPENID_CONNECT, SAML_1_1]\", \"status\": \"Must be one of [ACTIVE, INACTIVE, DELETED]\", \"visibility\": {\"appLinks\": \"object\", \"autoSubmitToolbar\": \"boolean\", \"hide\": {\"iOS\": \"boolean\", \"web\": \"boolean\"}}}",
"required": true,
"schema": {
"properties": {
"_embedded": {
"additionalProperties": {
"type": "object"
},
"readOnly": true,
"type": "object"
},
"_links": {
"additionalProperties": {
"type": "object"
},
"readOnly": true,
"type": "object"
},
"accessibility": {
"properties": {
"errorRedirectUrl": {
"type": "string"
},
"loginRedirectUrl": {
"type": "string"
},
"selfService": {
"type": "boolean"
}
},
"type": "object",
"x-okta-tags": [
"Application"
]
},
"created": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"credentials": {
"properties": {
"signing": {
"properties": {
"kid": {
"type": "string"
},
"lastRotated": {