Applications

The Applications API provides operations to manage applications and/or assignments to users or groups for your organization.

List all Applications
OAuth 2.0: okta.apps.read

Lists all applications with pagination. A subset of apps can be returned that match a supported filter expression or query.

Request
query Parameters
q
string
after
string

Specifies the pagination cursor for the next page of apps

limit
integer <int32>
Default: -1

Specifies the number of results for a page

filter
string

Filters apps by status, user.id, group.id or credentials.signing.kid expression

expand
string

Traverses users link relationship and optionally embeds Application User resource

includeNonDeleted
boolean
Default: false
Responses
200

Success

403

Forbidden

429

Too Many Requests

get/api/v1/apps
Request samples 
Response samples 
application/json
[
  • {
    • "accessibility": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "features": [
      ],
    • "id": "string",
    • "label": "string",
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "licensing": {
      },
    • "profile": {
      },
    • "signOnMode": "AUTO_LOGIN",
    • "status": "ACTIVE",
    • "visibility": {
      },
    • "_embedded": {
      },
    • "_links": {
      }
    }
]
Create an Application
OAuth 2.0: okta.apps.manage
Creates a new application to your Okta organization


Request 
query Parameters
activate
boolean
 Default:  true
Executes activation lifecycle operation when creating the app


 
header Parameters
OktaAccessGateway-Agent
string
 
Request Body schema: application/json
object (ApplicationAccessibility) 
 
errorRedirectUrl
string
 
loginRedirectUrl
string
 
selfService
boolean
 
features
Array of strings
 
label
string (ApplicationLabel) 
 
object (ApplicationLicensing) 
 
seatCount
integer
 
object
 
property name*
additional property
object
 
signOnMode
string (ApplicationSignOnMode) 
 
object (ApplicationVisibility) 
 
object
 
property name*
additional property
boolean
 
autoLaunch
boolean
 
autoSubmitToolbar
boolean
 
object (ApplicationVisibilityHide) 
 
iOS
boolean
 
web
boolean
 
object (ApplicationLinks) 
 
Array of objects (Link Object) 
 
 Array 
object
 
href
required
string
 
name
string
 
type
string
The media type of the link. If omitted, it is implicitly application/json.


 
object (SchemeApplicationCredentials) 
 
object
 
kid
string
 
rotationMode
string
 
use
string
 Value: "sig"  
object (ApplicationCredentialsUsernameTemplate) 
 
pushStatus
string
 
template
string
 
type
string
 
userSuffix
string
 
object (PasswordCredential) 
 
object (PasswordCredentialHash) 
 
object (PasswordCredentialHook) 
 
value
string <password> 
 
revealPassword
boolean
 
scheme
string (ApplicationCredentialsScheme) 
 Enum: "ADMIN_SETS_CREDENTIALS" "EDIT_PASSWORD_ONLY" "EDIT_USERNAME_AND_PASSWORD" "EXTERNAL_PASSWORD_SYNC" "SHARED_USERNAME_AND_PASSWORD"  
userName
string
 
name
string
 
object (AutoLoginApplicationSettings) 
 
identityStoreId
string
 
implicitAssignment
boolean
 
inlineHookId
string
 
object (ApplicationSettingsNotes) 
 
admin
string
 
enduser
string
 
object (ApplicationSettingsNotifications) 
 
object (ApplicationSettingsNotificationsVpn) 
 
object (AutoLoginApplicationSettingsSignOn) 
 
loginUrl
string
 
redirectUrl
string
 
Responses 
200
Success


400
Bad Request


403
Forbidden


429
Too Many Requests


post/api/v1/apps
Request samples 
application/json
{
  • "accessibility": {
    • "errorRedirectUrl": "string",
    • "loginRedirectUrl": "string",
    • "selfService": true
    },
  • "features": [
    • "string"
    ],
  • "label": "string",
  • "licensing": {
    • "seatCount": 0
    },
  • "profile": {
    • "property1": { },
    • "property2": { }
    },
  • "signOnMode": "AUTO_LOGIN",
  • "visibility": {
    • "appLinks": {
      },
    • "autoLaunch": true,
    • "autoSubmitToolbar": true,
    • "hide": {
      }
    },
  • "_links": {
    • "logo": [
      ]
    },
  • "credentials": {
    • "signing": {
      },
    • "userNameTemplate": {
      },
    • "password": {
      },
    • "revealPassword": true,
    • "scheme": "ADMIN_SETS_CREDENTIALS",
    • "userName": "string"
    },
  • "name": "string",
  • "settings": {
    • "identityStoreId": "string",
    • "implicitAssignment": true,
    • "inlineHookId": "string",
    • "notes": {
      },
    • "notifications": {
      },
    • "signOn": {
      }
    }
}
Response samples 
application/json
{
  • "accessibility": {
    • "errorRedirectUrl": "string",
    • "loginRedirectUrl": "string",
    • "selfService": true
    },
  • "created": "2019-08-24T14:15:22Z",
  • "features": [
    • "string"
    ],
  • "id": "string",
  • "label": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "licensing": {
    • "seatCount": 0
    },
  • "profile": {
    • "property1": { },
    • "property2": { }
    },
  • "signOnMode": "AUTO_LOGIN",
  • "status": "ACTIVE",
  • "visibility": {
    • "appLinks": {
      },
    • "autoLaunch": true,
    • "autoSubmitToolbar": true,
    • "hide": {
      }
    },
  • "_embedded": {
    • "property1": { },
    • "property2": { }
    },
  • "_links": {
    • "accessPolicy": {
      },
    • "activate": {
      },
    • "deactivate": {
      },
    • "groups": {
      },
    • "logo": [
      ],
    • "metadata": {
      },
    • "self": {
      },
    • "users": {
      }
    },
  • "credentials": {
    • "signing": {
      },
    • "userNameTemplate": {
      },
    • "password": {
      },
    • "revealPassword": true,
    • "scheme": "ADMIN_SETS_CREDENTIALS",
    • "userName": "string"
    },
  • "name": "string",
  • "settings": {
    • "identityStoreId": "string",
    • "implicitAssignment": true,
    • "inlineHookId": "string",
    • "notes": {
      },
    • "notifications": {
      },
    • "signOn": {
      }
    }
}
Retrieve an Application
OAuth 2.0: okta.apps.read
Retrieves an application from your Okta organization by id


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
query Parameters
expand
string
 
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}
Request samples 
Response samples 
application/json
{
  • "accessibility": {
    • "errorRedirectUrl": "string",
    • "loginRedirectUrl": "string",
    • "selfService": true
    },
  • "created": "2019-08-24T14:15:22Z",
  • "features": [
    • "string"
    ],
  • "id": "string",
  • "label": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "licensing": {
    • "seatCount": 0
    },
  • "profile": {
    • "property1": { },
    • "property2": { }
    },
  • "signOnMode": "AUTO_LOGIN",
  • "status": "ACTIVE",
  • "visibility": {
    • "appLinks": {
      },
    • "autoLaunch": true,
    • "autoSubmitToolbar": true,
    • "hide": {
      }
    },
  • "_embedded": {
    • "property1": { },
    • "property2": { }
    },
  • "_links": {
    • "accessPolicy": {
      },
    • "activate": {
      },
    • "deactivate": {
      },
    • "groups": {
      },
    • "logo": [
      ],
    • "metadata": {
      },
    • "self": {
      },
    • "users": {
      }
    },
  • "credentials": {
    • "signing": {
      },
    • "userNameTemplate": {
      },
    • "password": {
      },
    • "revealPassword": true,
    • "scheme": "ADMIN_SETS_CREDENTIALS",
    • "userName": "string"
    },
  • "name": "string",
  • "settings": {
    • "identityStoreId": "string",
    • "implicitAssignment": true,
    • "inlineHookId": "string",
    • "notes": {
      },
    • "notifications": {
      },
    • "signOn": {
      }
    }
}
Replace an Application
OAuth 2.0: okta.apps.manage
Replaces an application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Request Body schema: application/json
object (ApplicationAccessibility) 
 
errorRedirectUrl
string
 
loginRedirectUrl
string
 
selfService
boolean
 
features
Array of strings
 
label
string (ApplicationLabel) 
 
object (ApplicationLicensing) 
 
seatCount
integer
 
object
 
property name*
additional property
object
 
signOnMode
string (ApplicationSignOnMode) 
 
object (ApplicationVisibility) 
 
object
 
property name*
additional property
boolean
 
autoLaunch
boolean
 
autoSubmitToolbar
boolean
 
object (ApplicationVisibilityHide) 
 
iOS
boolean
 
web
boolean
 
object (ApplicationLinks) 
 
Array of objects (Link Object) 
 
 Array 
object
 
href
required
string
 
name
string
 
type
string
The media type of the link. If omitted, it is implicitly application/json.


 
object (SchemeApplicationCredentials) 
 
object
 
kid
string
 
rotationMode
string
 
use
string
 Value: "sig"  
object (ApplicationCredentialsUsernameTemplate) 
 
pushStatus
string
 
template
string
 
type
string
 
userSuffix
string
 
object (PasswordCredential) 
 
object (PasswordCredentialHash) 
 
object (PasswordCredentialHook) 
 
value
string <password> 
 
revealPassword
boolean
 
scheme
string (ApplicationCredentialsScheme) 
 Enum: "ADMIN_SETS_CREDENTIALS" "EDIT_PASSWORD_ONLY" "EDIT_USERNAME_AND_PASSWORD" "EXTERNAL_PASSWORD_SYNC" "SHARED_USERNAME_AND_PASSWORD"  
userName
string
 
name
string
 
object (AutoLoginApplicationSettings) 
 
identityStoreId
string
 
implicitAssignment
boolean
 
inlineHookId
string
 
object (ApplicationSettingsNotes) 
 
admin
string
 
enduser
string
 
object (ApplicationSettingsNotifications) 
 
object (ApplicationSettingsNotificationsVpn) 
 
object (AutoLoginApplicationSettingsSignOn) 
 
loginUrl
string
 
redirectUrl
string
 
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/apps/{appId}
Request samples 
application/json
{
  • "accessibility": {
    • "errorRedirectUrl": "string",
    • "loginRedirectUrl": "string",
    • "selfService": true
    },
  • "features": [
    • "string"
    ],
  • "label": "string",
  • "licensing": {
    • "seatCount": 0
    },
  • "profile": {
    • "property1": { },
    • "property2": { }
    },
  • "signOnMode": "AUTO_LOGIN",
  • "visibility": {
    • "appLinks": {
      },
    • "autoLaunch": true,
    • "autoSubmitToolbar": true,
    • "hide": {
      }
    },
  • "_links": {
    • "logo": [
      ]
    },
  • "credentials": {
    • "signing": {
      },
    • "userNameTemplate": {
      },
    • "password": {
      },
    • "revealPassword": true,
    • "scheme": "ADMIN_SETS_CREDENTIALS",
    • "userName": "string"
    },
  • "name": "string",
  • "settings": {
    • "identityStoreId": "string",
    • "implicitAssignment": true,
    • "inlineHookId": "string",
    • "notes": {
      },
    • "notifications": {
      },
    • "signOn": {
      }
    }
}
Response samples 
application/json
{
  • "accessibility": {
    • "errorRedirectUrl": "string",
    • "loginRedirectUrl": "string",
    • "selfService": true
    },
  • "created": "2019-08-24T14:15:22Z",
  • "features": [
    • "string"
    ],
  • "id": "string",
  • "label": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "licensing": {
    • "seatCount": 0
    },
  • "profile": {
    • "property1": { },
    • "property2": { }
    },
  • "signOnMode": "AUTO_LOGIN",
  • "status": "ACTIVE",
  • "visibility": {
    • "appLinks": {
      },
    • "autoLaunch": true,
    • "autoSubmitToolbar": true,
    • "hide": {
      }
    },
  • "_embedded": {
    • "property1": { },
    • "property2": { }
    },
  • "_links": {
    • "accessPolicy": {
      },
    • "activate": {
      },
    • "deactivate": {
      },
    • "groups": {
      },
    • "logo": [
      ],
    • "metadata": {
      },
    • "self": {
      },
    • "users": {
      }
    },
  • "credentials": {
    • "signing": {
      },
    • "userNameTemplate": {
      },
    • "password": {
      },
    • "revealPassword": true,
    • "scheme": "ADMIN_SETS_CREDENTIALS",
    • "userName": "string"
    },
  • "name": "string",
  • "settings": {
    • "identityStoreId": "string",
    • "implicitAssignment": true,
    • "inlineHookId": "string",
    • "notes": {
      },
    • "notifications": {
      },
    • "signOn": {
      }
    }
}
Delete an Application
OAuth 2.0: okta.apps.manage
Deletes an inactive application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/apps/{appId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}
Retrieve the default Provisioning Connection
OAuth 2.0: okta.apps.read
Retrieves the default Provisioning Connection for application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/connections/default
Request samples 
Response samples 
application/json
{
  • "authScheme": "TOKEN",
  • "status": "DISABLED",
  • "_links": {
    • "self": {
      }
    }
}
Update the default Provisioning Connection
OAuth 2.0: okta.apps.manage
Updates the default provisioning connection for application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
query Parameters
activate
boolean
 
Request Body schema: application/json
object (ProvisioningConnectionProfile) 
 
authScheme
string (ProvisioningConnectionAuthScheme) 
 Enum: "TOKEN" "UNKNOWN"  
token
string
 
Responses 
201
Created


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/connections/default
Request samples 
application/json
{
  • "profile": {
    • "authScheme": "TOKEN",
    • "token": "string"
    }
}
Response samples 
application/json
{
  • "authScheme": "TOKEN",
  • "status": "DISABLED",
  • "_links": {
    • "self": {
      }
    }
}
Activate the default Provisioning Connection
OAuth 2.0: okta.apps.manage
Activates the default Provisioning Connection for an application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/connections/default/lifecycle/activate
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}
Deactivate the default Provisioning Connection for an Application
OAuth 2.0: okta.apps.manage
Deactivates the default Provisioning Connection for an application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/connections/default/lifecycle/deactivate
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}
List all Certificate Signing Requests
OAuth 2.0: okta.apps.read
Lists all Certificate Signing Requests for an application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/credentials/csrs
Request samples 
Response samples 
application/json
[
  • {
    • "created": "2019-08-24T14:15:22Z",
    • "csr": "string",
    • "id": "string",
    • "kty": "string"
    }
]
Generate a Certificate Signing Request
OAuth 2.0: okta.apps.manage
Generates a new key pair and returns the Certificate Signing Request for it


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Request Body schema: application/json
object (CsrMetadataSubject) 
 
commonName
string
 
countryName
string
 
localityName
string
 
organizationalUnitName
string
 
organizationName
string
 
stateOrProvinceName
string
 
object (CsrMetadataSubjectAltNames) 
 
dnsNames
Array of strings
 
Responses 
201
Created


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/credentials/csrs
Request samples 
application/json
{
  • "subject": {
    • "commonName": "string",
    • "countryName": "string",
    • "localityName": "string",
    • "organizationalUnitName": "string",
    • "organizationName": "string",
    • "stateOrProvinceName": "string"
    },
  • "subjectAltNames": {
    • "dnsNames": [
      ]
    }
}
Response samples 
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "csr": "string",
  • "id": "string",
  • "kty": "string"
}
Retrieve a Certificate Signing Request
OAuth 2.0: okta.apps.read
Retrieves a certificate signing request for the app by id


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
csrId
required
string
id of the CSR


 
 Example:  fd7x1h7uTcZFx22rU1f7
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/credentials/csrs/{csrId}
Request samples 
Response samples 
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "csr": "string",
  • "id": "string",
  • "kty": "string"
}
Revoke a Certificate Signing Request
OAuth 2.0: okta.apps.manage
Revokes a certificate signing request and deletes the key pair from the application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
csrId
required
string
id of the CSR


 
 Example:  fd7x1h7uTcZFx22rU1f7
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/apps/{appId}/credentials/csrs/{csrId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}
Publish a Certificate Signing Request
OAuth 2.0: okta.apps.manage
Publishes a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
csrId
required
string
id of the CSR


 
 Example:  fd7x1h7uTcZFx22rU1f7
Request Body schema: 
string <binary> 
 
Responses 
201
Created


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish
Request samples 
Response samples 
application/json
{
  • "alg": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "e": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "key_ops": [
    • "string"
    ],
  • "kid": "string",
  • "kty": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "n": "string",
  • "status": "string",
  • "use": "string",
  • "x5c": [
    • "string"
    ],
  • "x5t": "string",
  • "x5t#S256": "string",
  • "x5u": "string",
  • "_links": {
    • "self": {
      }
    }
}
List all Key Credentials
OAuth 2.0: okta.apps.read
Lists all key credentials for an application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/credentials/keys
Request samples 
Response samples 
application/json
[
  • {
    • "alg": "string",
    • "created": "2019-08-24T14:15:22Z",
    • "e": "string",
    • "expiresAt": "2019-08-24T14:15:22Z",
    • "key_ops": [
      ],
    • "kid": "string",
    • "kty": "string",
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "n": "string",
    • "status": "string",
    • "use": "string",
    • "x5c": [
      ],
    • "x5t": "string",
    • "x5t#S256": "string",
    • "x5u": "string",
    • "_links": {
      }
    }
]
Generate a Key Credential
OAuth 2.0: okta.apps.manage
Generates a new X.509 certificate for an application key credential


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
query Parameters
validityYears
integer
 
Responses 
201
Created


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/credentials/keys/generate
Request samples 
Response samples 
application/json
{
  • "alg": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "e": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "key_ops": [
    • "string"
    ],
  • "kid": "string",
  • "kty": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "n": "string",
  • "status": "string",
  • "use": "string",
  • "x5c": [
    • "string"
    ],
  • "x5t": "string",
  • "x5t#S256": "string",
  • "x5u": "string",
  • "_links": {
    • "self": {
      }
    }
}
Retrieve a Key Credential
OAuth 2.0: okta.apps.read
Retrieves a specific application key credential by kid


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
keyId
required
string
id of the Key


 
 Example:  sjP9eiETijYz110VkhHN
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/credentials/keys/{keyId}
Request samples 
Response samples 
application/json
{
  • "alg": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "e": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "key_ops": [
    • "string"
    ],
  • "kid": "string",
  • "kty": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "n": "string",
  • "status": "string",
  • "use": "string",
  • "x5c": [
    • "string"
    ],
  • "x5t": "string",
  • "x5t#S256": "string",
  • "x5u": "string",
  • "_links": {
    • "self": {
      }
    }
}
Clone a Key Credential
OAuth 2.0: okta.apps.manage
Clones a X.509 certificate for an application key credential from a source application to target application.


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
keyId
required
string
id of the Key


 
 Example:  sjP9eiETijYz110VkhHN
query Parameters
targetAid
required
string
Unique key of the target Application


 
Responses 
201
Created


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/credentials/keys/{keyId}/clone
Request samples 
Response samples 
application/json
{
  • "alg": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "e": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "key_ops": [
    • "string"
    ],
  • "kid": "string",
  • "kty": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "n": "string",
  • "status": "string",
  • "use": "string",
  • "x5c": [
    • "string"
    ],
  • "x5t": "string",
  • "x5t#S256": "string",
  • "x5u": "string",
  • "_links": {
    • "self": {
      }
    }
}
List all Features
OAuth 2.0: okta.apps.read
Lists all features for an application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/features
Request samples 
Response samples 
application/json
[
  • {
    • "capabilities": {
      },
    • "description": "string",
    • "name": "string",
    • "status": "DISABLED",
    • "_links": {
      }
    }
]
Retrieve a Feature
OAuth 2.0: okta.apps.read
Retrieves a Feature object for an application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
featureName
required
string
Name of the Feature


 
 Example:  GROUP_PUSH
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/features/{featureName}
Request samples 
Response samples 
application/json
{
  • "capabilities": {
    • "create": {
      },
    • "update": {
      }
    },
  • "description": "string",
  • "name": "string",
  • "status": "DISABLED",
  • "_links": {
    • "self": {
      }
    }
}
Update a Feature
OAuth 2.0: okta.apps.manage
Updates a Feature object for an application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
featureName
required
string
Name of the Feature


 
 Example:  GROUP_PUSH
Request Body schema: application/json
object (CapabilitiesCreateObject) 
 
object (LifecycleCreateSettingObject) 
 
status
string (EnabledStatus) 
 Enum: "DISABLED" "ENABLED"  
object (CapabilitiesUpdateObject) 
 
object (LifecycleDeactivateSettingObject) 
 
status
string (EnabledStatus) 
 Enum: "DISABLED" "ENABLED"  
object (PasswordSettingObject) 
 
change
string (ChangeEnum) 
 Enum: "CHANGE" "KEEP_EXISTING"  
seed
string (SeedEnum) 
 Enum: "OKTA" "RANDOM"  
status
string (EnabledStatus) 
 Enum: "DISABLED" "ENABLED"  
object (ProfileSettingObject) 
 
status
string (EnabledStatus) 
 Enum: "DISABLED" "ENABLED"  
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/apps/{appId}/features/{featureName}
Request samples 
application/json
{
  • "create": {
    • "lifecycleCreate": {
      }
    },
  • "update": {
    • "lifecycleDeactivate": {
      },
    • "password": {
      },
    • "profile": {
      }
    }
}
Response samples 
application/json
{
  • "capabilities": {
    • "create": {
      },
    • "update": {
      }
    },
  • "description": "string",
  • "name": "string",
  • "status": "DISABLED",
  • "_links": {
    • "self": {
      }
    }
}
List all Scope Consent Grants
OAuth 2.0: okta.appGrants.read
Lists all scope consent grants for the application


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
query Parameters
expand
string
 
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/grants
Request samples 
Response samples 
application/json
[
  • {
    • "clientId": "string",
    • "created": "2019-08-24T14:15:22Z",
    • "createdBy": {
      },
    • "id": "string",
    • "issuer": "string",
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "scopeId": "string",
    • "source": "ADMIN",
    • "status": "ACTIVE",
    • "userId": "string",
    • "_embedded": {
      },
    • "_links": {
      }
    }
]
Grant Consent to Scope
OAuth 2.0: okta.appGrants.manage
Grants consent for the application to request an OAuth 2.0 Okta scope


Request 
path Parameters
appId
required
string
id of the Application


 
 Example:  0oafxqCAJWWGELFTYASJ
Request Body schema: application/json
clientId
string
 
object (OAuth2Actor) 
 
type
string
 
issuer
string
 
scopeId
string
 
source
string (OAuth2ScopeConsentGrantSource) 
 Enum: "ADMIN" "END_USER"  
status
string (GrantOrTokenStatus) 
 Enum: "ACTIVE" "REVOKED"  
userId
string
 
Responses 
201
Created


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/apps/{appId}/grants
Request samples