POST /privileged-access/api/v1/service-accounts

Creates a new app service account for managing an app account

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
username String Yes

The username that serves as the direct link to your managed app account. Ensure that this value precisely matches the identifier of the target app account.

description String No

The description of the app service account

ownerGroupIds[] Array No

A list of IDs of the Okta groups who own the app service account

status String No

Describes the current status of an app service account

Valid values:

  • "ERROR"
  • "UNSECURED"
  • "ALERT"
  • "NO_ISSUES"
  • "INFO"
containerGlobalName String No

The key name of the app in the Okta Integration Network (OIN)

lastUpdated String No

Timestamp when the app service account was last updated

containerInstanceName String No

The app instance label

id String No

The UUID of the app service account

statusDetail String No

Describes the detailed status of an app service account

Valid values:

  • "PENDING"
  • "MISSING_PASSWORD"
  • "VAULTED"
  • "ROTATION_FAILED"
  • "STAGED"
  • "UNMANAGED"
  • "ROTATING"
  • "CREATION_FAILED"
  • "ROTATED"
ownerUserIds[] Array No

A list of IDs of the Okta users who own the app service account

created String No

Timestamp when the app service account was created

name String Yes

The user-defined name for the app service account

containerOrn String Yes

The ORN of the relevant resource.

Use the specific app ORN format (orn:{partition}:idp:{yourOrgId}:apps:{appType}:{appId}) to identify an Okta app instance in your org.

password String No

The app service account password. Required for apps that don't have provisioning enabled or don't support password synchronization.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.