ByteChef LogoByteChef

Okta

Okta is an identity and access management platform that manages users, groups and application assignments, providing single sign-on and lifecycle management for workforce and customer identities.

Categories: Developer Tools

Type: okta/v1


Connections

Version: 1

API Token

Properties

NameLabelTypeDescriptionRequired
domainOkta DomainSTRINGThe domain of your Okta organization, for example your-org.okta.com.true
tokenAPI TokenSTRINGTo create an API token, go to Security -> API -> Tokens in the Okta Admin Console and click Create token.true

Connection Setup

Find your Okta domain

Your Okta domain is the host name of your Okta organization, for example your-org.okta.com or your-org.oktapreview.com. You can see it in the address bar after you sign in to the Okta Admin Console (without the -admin part), or in the upper-right corner of the Admin Console under your user name.

Create an API token

  1. Sign in to the Okta Admin Console as an administrator.
  2. Go to Security -> API.
  3. Open the Tokens tab.
  4. Click Create token.
  5. Enter a name for the token and click Create token.
  6. Copy the token value. Okta shows it only once.

An API token has the permissions of the administrator who created it, so create it with an administrator account that can read users, groups and apps.

Configure the connection

  1. Enter your Okta domain in Okta Domain.
  2. Paste the token into API Token. ByteChef sends it in the Authorization: SSWS <token> header.

Actions

Get User

Name: getUser

Get a user by ID, login or login shortname.

Properties

NameLabelTypeDescriptionRequired
userIdUser IDSTRINGThe ID, login or login shortname of the user.true

Example JSON Structure

{
  "label" : "Get User",
  "name" : "getUser",
  "parameters" : {
    "userId" : ""
  },
  "type" : "okta/v1/getUser"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idSTRINGThe unique ID of the user.
statusSTRINGThe status of the user, for example ACTIVE, STAGED, PROVISIONED, SUSPENDED, LOCKED_OUT, PASSWORD_EXPIRED, RECOVERY or DEPROVISIONED.
createdSTRINGISO 8601 timestamp for when the user was created.
activatedSTRINGISO 8601 timestamp for when the user was activated.
statusChangedSTRINGISO 8601 timestamp for when the status of the user last changed.
lastLoginSTRINGISO 8601 timestamp of the last login of the user.
lastUpdatedSTRINGISO 8601 timestamp for when the user was last updated.
passwordChangedSTRINGISO 8601 timestamp for when the password of the user last changed.
typeOBJECT
Properties {STRING(id)}
The user type.
profileOBJECT
Properties {STRING(login), STRING(email), STRING(secondEmail), STRING(firstName), STRING(lastName), STRING(displayName), STRING(mobilePhone), STRING(title), STRING(department)}
The profile properties of the user.

Output Example

{
  "id" : "",
  "status" : "",
  "created" : "",
  "activated" : "",
  "statusChanged" : "",
  "lastLogin" : "",
  "lastUpdated" : "",
  "passwordChanged" : "",
  "type" : {
    "id" : ""
  },
  "profile" : {
    "login" : "",
    "email" : "",
    "secondEmail" : "",
    "firstName" : "",
    "lastName" : "",
    "displayName" : "",
    "mobilePhone" : "",
    "title" : "",
    "department" : ""
  }
}

List Users

Name: listUsers

List users in the Okta organization, optionally narrowed by a search expression, a filter expression or a simple query.

Properties

NameLabelTypeDescriptionRequired
searchSearchSTRINGSearch expression that matches most user properties, for example profile.department eq "Engineering" or status eq "ACTIVE". Recommended over Filter and Query.false
filterFilterSTRINGFilter expression on a limited set of properties (status, lastUpdated, id, profile.login, profile.email, profile.firstName, profile.lastName), for example status eq "ACTIVE".false
qQuerySTRINGMatches the beginning of the first name, last name or email of users. Doesn't return deprovisioned users and doesn't support pagination.false
limitLimitINTEGERMaximum number of results to return. Results are fetched page by page until this number is reached. Leave empty to return all results.false

Example JSON Structure

{
  "label" : "List Users",
  "name" : "listUsers",
  "parameters" : {
    "search" : "",
    "filter" : "",
    "q" : "",
    "limit" : 1
  },
  "type" : "okta/v1/listUsers"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idSTRINGThe unique ID of the user.
statusSTRINGThe status of the user, for example ACTIVE, STAGED, PROVISIONED, SUSPENDED, LOCKED_OUT, PASSWORD_EXPIRED, RECOVERY or DEPROVISIONED.
createdSTRINGISO 8601 timestamp for when the user was created.
activatedSTRINGISO 8601 timestamp for when the user was activated.
statusChangedSTRINGISO 8601 timestamp for when the status of the user last changed.
lastLoginSTRINGISO 8601 timestamp of the last login of the user.
lastUpdatedSTRINGISO 8601 timestamp for when the user was last updated.
passwordChangedSTRINGISO 8601 timestamp for when the password of the user last changed.
typeOBJECT
Properties {STRING(id)}
The user type.
profileOBJECT
Properties {STRING(login), STRING(email), STRING(secondEmail), STRING(firstName), STRING(lastName), STRING(displayName), STRING(mobilePhone), STRING(title), STRING(department)}
The profile properties of the user.

Output Example

[ {
  "id" : "",
  "status" : "",
  "created" : "",
  "activated" : "",
  "statusChanged" : "",
  "lastLogin" : "",
  "lastUpdated" : "",
  "passwordChanged" : "",
  "type" : {
    "id" : ""
  },
  "profile" : {
    "login" : "",
    "email" : "",
    "secondEmail" : "",
    "firstName" : "",
    "lastName" : "",
    "displayName" : "",
    "mobilePhone" : "",
    "title" : "",
    "department" : ""
  }
} ]

List User Groups

Name: listUserGroups

List the groups the user is a member of.

Properties

NameLabelTypeDescriptionRequired
userIdUser IDSTRINGThe ID, login or login shortname of the user.true

Example JSON Structure

{
  "label" : "List User Groups",
  "name" : "listUserGroups",
  "parameters" : {
    "userId" : ""
  },
  "type" : "okta/v1/listUserGroups"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idSTRINGThe unique ID of the group.
typeSTRINGThe type of the group: OKTA_GROUP, APP_GROUP or BUILT_IN.
createdSTRINGISO 8601 timestamp for when the group was created.
lastUpdatedSTRINGISO 8601 timestamp for when the group profile was last updated.
lastMembershipUpdatedSTRINGISO 8601 timestamp for when the group memberships were last updated.
objectClassARRAY
Items [STRING]
The object classes of the group.
profileOBJECT
Properties {STRING(name), STRING(description)}
The profile properties of the group.

Output Example

[ {
  "id" : "",
  "type" : "",
  "created" : "",
  "lastUpdated" : "",
  "lastMembershipUpdated" : "",
  "objectClass" : [ "" ],
  "profile" : {
    "name" : "",
    "description" : ""
  }
} ]

Name: listUserAppLinks

List the app links of all apps assigned to the user.

Properties

NameLabelTypeDescriptionRequired
userIdUser IDSTRINGThe ID, login or login shortname of the user.true

Example JSON Structure

{
  "label" : "List User App Links",
  "name" : "listUserAppLinks",
  "parameters" : {
    "userId" : ""
  },
  "type" : "okta/v1/listUserAppLinks"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idSTRINGThe ID of the app link.
labelSTRINGThe display name of the app link.
linkUrlSTRINGThe URL of the app link.
logoUrlSTRINGThe URL of the app logo.
appNameSTRINGThe name of the app.
appInstanceIdSTRINGThe ID of the app instance.
appAssignmentIdSTRINGThe ID of the app assignment.
credentialsSetupBOOLEAN
Options true, false
Whether credentials setup is required.
hiddenBOOLEAN
Options true, false
Whether the app link is hidden.
sortOrderINTEGERThe position of the app link in the sort order.

Output Example

[ {
  "id" : "",
  "label" : "",
  "linkUrl" : "",
  "logoUrl" : "",
  "appName" : "",
  "appInstanceId" : "",
  "appAssignmentId" : "",
  "credentialsSetup" : false,
  "hidden" : false,
  "sortOrder" : 1
} ]

List Group Members

Name: listGroupMembers

List the users that are members of the group.

Properties

NameLabelTypeDescriptionRequired
groupIdGroup IDSTRINGThe ID of the group.true
limitLimitINTEGERMaximum number of results to return. Results are fetched page by page until this number is reached. Leave empty to return all results.false

Example JSON Structure

{
  "label" : "List Group Members",
  "name" : "listGroupMembers",
  "parameters" : {
    "groupId" : "",
    "limit" : 1
  },
  "type" : "okta/v1/listGroupMembers"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idSTRINGThe unique ID of the user.
statusSTRINGThe status of the user, for example ACTIVE, STAGED, PROVISIONED, SUSPENDED, LOCKED_OUT, PASSWORD_EXPIRED, RECOVERY or DEPROVISIONED.
createdSTRINGISO 8601 timestamp for when the user was created.
activatedSTRINGISO 8601 timestamp for when the user was activated.
statusChangedSTRINGISO 8601 timestamp for when the status of the user last changed.
lastLoginSTRINGISO 8601 timestamp of the last login of the user.
lastUpdatedSTRINGISO 8601 timestamp for when the user was last updated.
passwordChangedSTRINGISO 8601 timestamp for when the password of the user last changed.
typeOBJECT
Properties {STRING(id)}
The user type.
profileOBJECT
Properties {STRING(login), STRING(email), STRING(secondEmail), STRING(firstName), STRING(lastName), STRING(displayName), STRING(mobilePhone), STRING(title), STRING(department)}
The profile properties of the user.

Output Example

[ {
  "id" : "",
  "status" : "",
  "created" : "",
  "activated" : "",
  "statusChanged" : "",
  "lastLogin" : "",
  "lastUpdated" : "",
  "passwordChanged" : "",
  "type" : {
    "id" : ""
  },
  "profile" : {
    "login" : "",
    "email" : "",
    "secondEmail" : "",
    "firstName" : "",
    "lastName" : "",
    "displayName" : "",
    "mobilePhone" : "",
    "title" : "",
    "department" : ""
  }
} ]

List Group Apps

Name: listGroupApps

List the apps assigned to the group.

Properties

NameLabelTypeDescriptionRequired
groupIdGroup IDSTRINGThe ID of the group.true
limitLimitINTEGERMaximum number of results to return. Results are fetched page by page until this number is reached. Leave empty to return all results.false

Example JSON Structure

{
  "label" : "List Group Apps",
  "name" : "listGroupApps",
  "parameters" : {
    "groupId" : "",
    "limit" : 1
  },
  "type" : "okta/v1/listGroupApps"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idSTRINGThe unique ID of the app instance.
nameSTRINGThe key name of the app.
labelSTRINGThe user-defined display name of the app.
statusSTRINGThe status of the app: ACTIVE or INACTIVE.
signOnModeSTRINGThe authentication mode of the app.
createdSTRINGISO 8601 timestamp for when the app was created.
lastUpdatedSTRINGISO 8601 timestamp for when the app was last updated.

Output Example

[ {
  "id" : "",
  "name" : "",
  "label" : "",
  "status" : "",
  "signOnMode" : "",
  "created" : "",
  "lastUpdated" : ""
} ]

List Application Users

Name: listApplicationUsers

List the users assigned to the app.

Properties

NameLabelTypeDescriptionRequired
appIdApp IDSTRINGThe ID of the app.true
qQuerySTRINGMatches the beginning of the username, first name, last name or email of the assigned users.false
limitLimitINTEGERMaximum number of results to return. Results are fetched page by page until this number is reached. Leave empty to return all results.false

Example JSON Structure

{
  "label" : "List Application Users",
  "name" : "listApplicationUsers",
  "parameters" : {
    "appId" : "",
    "q" : "",
    "limit" : 1
  },
  "type" : "okta/v1/listApplicationUsers"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idSTRINGThe Okta ID of the user.
externalIdSTRINGThe ID of the user in the target app.
scopeSTRINGUSER for a direct assignment or GROUP for an assignment through group membership.
statusSTRINGThe status of the app user.
syncStateSTRINGThe synchronization state of the app user.
createdSTRINGISO 8601 timestamp for when the app user was created.
lastUpdatedSTRINGISO 8601 timestamp for when the app user was last updated.
lastSyncSTRINGISO 8601 timestamp of the last synchronization of the app user.
statusChangedSTRINGISO 8601 timestamp for when the status of the app user last changed.
credentialsOBJECT
Properties {STRING(userName)}
The app credentials of the user.
profileOBJECT
Properties {}
The app-specific profile properties of the user.

Output Example

[ {
  "id" : "",
  "externalId" : "",
  "scope" : "",
  "status" : "",
  "syncState" : "",
  "created" : "",
  "lastUpdated" : "",
  "lastSync" : "",
  "statusChanged" : "",
  "credentials" : {
    "userName" : ""
  },
  "profile" : { }
} ]

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

How is this guide?

Last updated on

On this page