Okta

×

REQUEST FREE TRIAL

Share A Little Information To Request Free Trial

Created with Sketch.
REQUEST FREE TRIAL

Okta is an on-demand identity and access management service for web based applications, both in the cloud and behind the firewall.

Operations

Authentication

To create an authentication with Okta you will need an Okta domain and an API Token.

Log in to the Okta app and click on Token under the API menu in the top navigation bar, then click on Create Token (Make a note of the token as you won't be able to see it again).

You can find the Okta domain your Okta Dashboard, you don't need to include https.

Pagination

Whenever an operation makes use of pagination, its output will also return the next property containing the cursor for the next page, if there is one. If an operation makes use of pagination, you will find the After property where you will insert the next property value.

When looping through a list, you can check whether the next property value is equal to null to exit the loop or use it to specify the After property value.

Add user to group

The Add user to group operation allows you to add a user to a group.

The Group ID property allows you to specify the group ID, which can also be obtained through the List groups operation.

The User ID property allows you to specify the user ID, which can also be obtained through the List users operation.

Create group

The Create Group operation allows you to create a group in your organisation. The group type will be OKTA_GROUP.

The Name property allows you to specify the name of the new group, which should be a string between 1 and 255 characters long.

The Description property allows you to specify the description of the new group, which should be a string between 0 and 1024 characters long.

Create user

The Create user operation allows you to create a new user.

The Activate user property allows you to automatically activate the new account without asking the user to verify the email address.

The Force password change property allows you to force the user to change the password (Only possible if the Activate user property is checked).

The Provider property allows you to specify the authentication provider. If checked, then the Provider Type and the Provider Name fields (in the Credentials property) will be used.

The Profile property allows you to specify the information related to the user.

The Credentials property allows you to specify the user sensitive information, such as password and recovery question.

Get group

The Get group operation retrieves information about a group in your organisation.

The ID property allows you to specify the group ID, which can also be obtained through the List groups operation.

Get system logs

The Get system logs operation retrieves information about the events related to your organisation in order to provide an audit trail that can be used to understand platform activity and to diagnose problems.

The Limit property allows you to specify the number of events returned.

The After property allows you to specify the number of events to be skipped. Read more about this property here.

Get user

The Get user operation retrieves information about a specific user.

The ID property allows you to specify the user ID, which can also be obtained through the List users operation.

List group members

The List group members operation retrieves a list of users that are member of a specific group.

The ID property allows you to specify the group ID, which can also be obtained through the List groups operation.

The Limit property allows you to specify the number of users returned.

The After property allows you to specify the number of users to be skipped. Read more about this property here.

List groups

The List groups operation retrieves a list of groups.

The Find groups property allows you to find groups based on their name.

The Filter property allows you to specify Filter expressions. Read more here

The Limit property allows you to specify the number of groups returned.

The After property allows you to specify the number of groups to be skipped. Read more about this property here.

List users

The List users operation retrieves a list of users.

The Find users property allows you to find users based on their First name, Last name or Email.

The Filter property allows you to specify Filter expressions. Read more here

The Limit property allows you to specify the number of groups returned.

The After property allows you to specify the number of groups to be skipped. Read more about this property here.

Remove user from a group

The Remove user from a group allows you to remove a user from a group.

The Group ID property allows you to specify the group ID, which can also be obtained through the List groups operation.

The User ID property allows you to specify the user ID, which can also be obtained through the List users operation.

Update group

The Update group operation allows you to update a group.

The ID property allows you to specify the group ID, which can also be obtained through the List groups operation.

The Name property allows you to specify the group name.

The Description property allows you to specify the group description.

Update user

The Update user operation allows you to update a user.

The User ID property allows you to specify the user ID, which can also be obtained through the List users operation.

The Strict property allows you to specify whether Okta should validate against minimum age and history password policy or not.

The Profile property allows you to specify the information related to the user.

The Credentials property allows you to specify the user sensitive information, such as password and recovery question.

Last updated 22nd March 2018

REQUEST FREE TRIAL

Share A Little Information To Request Free Trial

Created with Sketch.