Okta

Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.

Adds a new application to your Okta organization.

{
  "$ref": "#/components/requestBodies/Application"
}

Removes an inactive application.

Fetches an application from your Okta organization by `id`.

Updates an application in your organization.

{
  "$ref": "#/components/requestBodies/Application"
}

Get default Provisioning Connection for application

Set default Provisioning Connection for application

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ProvisioningConnectionRequest"
      }
    }
  },
  "required": true
}

Activates the default Provisioning Connection for an application.

Deactivates the default Provisioning Connection for an application.

Enumerates Certificate Signing Requests for an application

Generates a new key pair and returns the Certificate Signing Request for it.

{
  "$ref": "#/components/requestBodies/CsrMetadata"
}

Enumerates key credentials for an application

Generates a new X.509 certificate for an application key credential

Gets a specific application key credential by kid

Clones a X.509 certificate for an application key credential from a source application to target application.

Enumerates the client's collection of secrets

Adds a new secret to the client's collection of secrets.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ClientSecretMetadata"
      }
    }
  },
  "required": true
}

Removes a secret from the client's collection of secrets.

Gets a specific client secret by secretId

Activates a specific client secret by secretId

Deactivates a specific client secret by secretId

List Features for application

Fetches a Feature object for an application.

Updates a Feature object for an application.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/CapabilitiesObject"
      }
    }
  },
  "required": true
}

Lists all scope consent grants for the application

Grants consent for the application to request an OAuth 2.0 Okta scope

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OAuth2ScopeConsentGrant"
      }
    }
  },
  "required": true
}

Revokes permission for the application to request the given scope

Fetches a single scope consent grant for the application

Enumerates group assignments for an application.

Removes a group assignment from an application.

Fetches an application group assignment

Assigns a group to an application

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ApplicationGroupAssignment"
      }
    }
  }
}

Activates an inactive application.

Deactivates an active application.

Update the logo for an application.

{
  "$ref": "#/components/requestBodies/uploadApplicationLogo"
}

Assign an application to a specific policy. This unassigns the application from its currently assigned policy.

Previews SAML metadata based on a specific key credential for an application

Revokes all tokens for the specified application

Lists all tokens for the application

Revokes the specified token for the specified application

Gets a token for the specified application

Enumerates all assigned [application users](https://raw.githubusercontent.com) for an application.

Assigns an user to an application with [credentials](https://raw.githubusercontent.com) and an app-specific [profile](https://raw.githubusercontent.com). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

{
  "$ref": "#/components/requestBodies/AppUser"
}

Removes an assignment for a user from an application.

Fetches a specific user assignment for application by `id`.

Updates a user's profile for an application

{
  "$ref": "#/components/requestBodies/AppUser"
}

List Authenticators

Create Authenticator

{
  "$ref": "#/components/requestBodies/Authenticator"
}

Success

Updates an authenticator

{
  "$ref": "#/components/requestBodies/Authenticator"
}

Success

Success

Success

Success

{
  "$ref": "#/components/requestBodies/AuthorizationServer"
}

Success

Success

Success

{
  "$ref": "#/components/requestBodies/AuthorizationServer"
}

Success

Success

{
  "$ref": "#/components/requestBodies/OAuth2Claim"
}

Success

Success

Success

{
  "$ref": "#/components/requestBodies/OAuth2Claim"
}

Success

Success

Success

Success

Success

Success

Success

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/JwkUse"
      }
    }
  },
  "required": true
}

Success

Success

Success

Success

{
  "$ref": "#/components/requestBodies/AuthorizationServerPolicy"
}

Success

Success

Success

{
  "$ref": "#/components/requestBodies/AuthorizationServerPolicy"
}

Activate Authorization Server Policy

Deactivate Authorization Server Policy

Enumerates all policy rules for the specified Custom Authorization Server and Policy.

Creates a policy rule for the specified Custom Authorization Server and Policy.

{
  "$ref": "#/components/requestBodies/AuthorizationServerPolicyRule"
}

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.

Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.

{
  "$ref": "#/components/requestBodies/AuthorizationServerPolicyRule"
}

Activate Authorization Server Policy Rule

Deactivate Authorization Server Policy Rule

Success

Success

{
  "$ref": "#/components/requestBodies/OAuth2Scope"
}

Success

Success

Success

{
  "$ref": "#/components/requestBodies/OAuth2Scope"
}

List all the brands in your org.

Fetches a brand by `brandId`

Updates a brand by `brandId`

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Brand"
      }
    }
  },
  "required": true
}

List email templates in your organization with pagination.

Fetch an email template by templateName

Delete all customizations for an email template. Also known as “Reset to Default”.

List all email customizations for an email template

Create an email customization

{
  "$ref": "#/components/requestBodies/EmailTemplateCustomizationRequest"
}

Delete an email customization

Fetch an email customization by id.

Update an email customization

{
  "$ref": "#/components/requestBodies/EmailTemplateCustomizationRequest"
}

Get a preview of an email template customization.

Fetch the default content for an email template.

Fetch a preview of an email template's default content by populating velocity references with the current user's environment.

Send a test email to the current users primary and secondary email addresses. The email content is selected based on the following priority: An email customization specifically for the users locale. The default language of email customizations. The email templates default content.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EmailTemplateTestRequest"
      }
    }
  },
  "required": true
}

List all the themes in your brand

Fetches a theme for a brand

Updates a theme for a brand

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Theme"
      }
    }
  },
  "required": true
}

Deletes a Theme background image

Updates the background image for your Theme

{
  "$ref": "#/components/requestBodies/uploadApplicationLogo"
}

Deletes a Theme favicon. The org then uses the Okta default favicon.

Updates the favicon for your theme

{
  "$ref": "#/components/requestBodies/uploadApplicationLogo"
}

Deletes a Theme logo. The org then uses the Okta default logo.

Updates the logo for your Theme

{
  "$ref": "#/components/requestBodies/uploadApplicationLogo"
}

List all verified custom Domains for the org.

Creates your domain.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Domain"
      }
    }
  },
  "required": true
}

Deletes a Domain by `id`.

Fetches a Domain by `id`.

Creates the Certificate for the Domain.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DomainCertificate"
      }
    }
  },
  "required": true
}

Verifies the Domain by `id`.

Success

Success

{
  "$ref": "#/components/requestBodies/EventHook"
}

Success

Success

Success

{
  "$ref": "#/components/requestBodies/EventHook"
}

Success

Success

Success

Success

Success

Success

Success

Success

Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.

Adds a new group with `OKTA_GROUP` type to your organization.

{
  "$ref": "#/components/requestBodies/Group"
}

Lists all group rules for your organization.

Creates a group rule to dynamically add users to the specified group if they match the condition

{
  "$ref": "#/components/requestBodies/GroupRule"
}

Removes a specific group rule by id from your organization

Fetches a specific group rule by id from your organization

Updates a group rule. Only `INACTIVE` rules can be updated.

{
  "$ref": "#/components/requestBodies/GroupRule"
}

Activates a specific group rule by id from your organization

Deactivates a specific group rule by id from your organization

Removes a group with `OKTA_GROUP` type from your organization.

Fetches a group from your organization.

Updates the profile for a group with `OKTA_GROUP` type from your organization.

{
  "$ref": "#/components/requestBodies/Group"
}

Enumerates all applications that are assigned to a group.

Success

Assigns a Role to a Group

{
  "$ref": "#/components/requestBodies/AssignRoleRequest"
}

Unassigns a Role from a Group

Success

Lists all App targets for an `APP_ADMIN` Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.

Success

Success

Remove App Instance Target to App Administrator Role given to a Group

Add App Instance Target to App Administrator Role given to a Group

Success

Enumerates all users that are a member of a group.

Removes a user from a group with 'OKTA_GROUP' type.

Adds a user to a group with 'OKTA_GROUP' type.

Fetches the group schema

Updates, adds ore removes one or more custom Group Profile properties in the schema

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GroupSchema"
      }
    }
  }
}

Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.

Adds a new IdP to your organization.

{
  "$ref": "#/components/requestBodies/IdentityProvider"
}

Enumerates IdP key credentials.

Adds a new X.509 certificate credential to the IdP key store.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/JsonWebKey"
      }
    }
  },
  "required": true
}

Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP.

Gets a specific IdP Key Credential by `kid`

Removes an IdP from your organization.

Fetches an IdP by `id`.

Updates the configuration for an IdP.

{
  "$ref": "#/components/requestBodies/IdentityProvider"
}

Enumerates Certificate Signing Requests for an IdP

Generates a new key pair and returns a Certificate Signing Request for it.

{
  "$ref": "#/components/requestBodies/CsrMetadata"
}

Revoke a Certificate Signing Request and delete the key pair from the IdP

Gets a specific Certificate Signing Request model by id

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.