> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/onelogin.md).

# OneLogin

Manage identities in OneLogin: create users, control roles and account access, and generate password reset links.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| OneLogin  | Credentials    |

#### OneLogin

Connect to the OneLogin API with an API credential pair to manage users, roles, and account access.

**Set up in OneLogin**

1. Prepare the OneLogin account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client ID:** Client ID of an API credential pair created in the OneLogin admin portal under Developers > API Credentials, with the 'Manage All' scope.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **OneLogin**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                           |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Subdomain     | Yes      | Your OneLogin subdomain — the first part of your OneLogin URL. For acme.onelogin.com, enter 'acme'. [Provider instructions](https://www.onelogin.com/). |
| Client ID     | Yes      | Client ID of an API credential pair created in the OneLogin admin portal under Developers > API Credentials, with the 'Manage All' scope.               |
| Client Secret | Yes      | Client Secret of the same API credential pair.                                                                                                          |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **OneLogin** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create User

Create a new user in OneLogin.

**Inputs**

| Field                    | Type                      | Required | Description                                                                                                                                                                                           |
| ------------------------ | ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Email                    | string                    | Yes      | Email address of the user to create.                                                                                                                                                                  |
| Username                 | string                    | No       | Sign-in username (defaults to the email address).                                                                                                                                                     |
| First Name               | string                    | No       | First name of the user.                                                                                                                                                                               |
| Last Name                | string                    | No       | Last name of the user.                                                                                                                                                                                |
| Password                 | secret                    | No       | Initial password for the user.                                                                                                                                                                        |
| Phone                    | string                    | No       | Phone number in E.164 format.                                                                                                                                                                         |
| Job Title                | string                    | No       | Job title of the user.                                                                                                                                                                                |
| Department               | string                    | No       | Department of the user.                                                                                                                                                                               |
| Company                  | string                    | No       | Company of the user.                                                                                                                                                                                  |
| Status                   | select (string)           | No       | Initial account status (defaults to Unactivated). Available values: Unactivated, Active, Suspended, Locked, Password Expired, Awaiting Password Reset, Password Pending, Security Questions Required. |
| Roles                    | multiple\_select (string) | No       | Roles to assign to the new user. Options load from the selected connection.                                                                                                                           |
| Custom Attributes (JSON) | textarea                  | No       | Optional JSON object stored as the user's custom attributes.                                                                                                                                          |

**Outputs**

| Field          | Type   | Description                     |
| -------------- | ------ | ------------------------------- |
| User           | object | The created OneLogin user.      |
| User ID        | number | Numeric ID of the created user. |
| Email          | string | Email of the created user.      |
| Result Message | string | Human-readable result summary.  |

#### Add User Role

Add a OneLogin user to a role.

**Inputs**

| Field | Type            | Required | Description                                                                                  |
| ----- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Role  | select (string) | Yes      | Select the role, or type its numeric ID. Options load from the selected connection.          |
| User  | select (string) | Yes      | Select the user to add, or type their numeric ID. Options load from the selected connection. |

**Outputs**

| Field          | Type   | Description                                   |
| -------------- | ------ | --------------------------------------------- |
| User ID        | number | Numeric ID of the user added to the role.     |
| Role ID        | number | Numeric ID of the role the user was added to. |
| Result Message | string | Human-readable result summary.                |

#### Remove User From Role

Remove a OneLogin user from a role.

**Inputs**

| Field | Type            | Required | Description                                                                                     |
| ----- | --------------- | -------- | ----------------------------------------------------------------------------------------------- |
| Role  | select (string) | Yes      | Select the role, or type its numeric ID. Options load from the selected connection.             |
| User  | select (string) | Yes      | Select the user to remove, or type their numeric ID. Options load from the selected connection. |

**Outputs**

| Field          | Type   | Description                                       |
| -------------- | ------ | ------------------------------------------------- |
| User ID        | number | Numeric ID of the user removed from the role.     |
| Role ID        | number | Numeric ID of the role the user was removed from. |
| Result Message | string | Human-readable result summary.                    |

#### Lock User Account

Lock a OneLogin user account so the user cannot sign in.

**Inputs**

| Field                   | Type            | Required | Description                                                                                                           |
| ----------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| User                    | select (string) | Yes      | Select the user to lock, or type their numeric ID. Options load from the selected connection.                         |
| Lock Duration (Minutes) | integer         | No       | How long to lock the account, in minutes. 0 locks per the account policy (indefinitely if there is none). Default: 0. |

**Outputs**

| Field                   | Type   | Description                                              |
| ----------------------- | ------ | -------------------------------------------------------- |
| User ID                 | number | Numeric ID of the locked user.                           |
| Lock Duration (Minutes) | number | Requested lock duration in minutes (0 = policy default). |
| Result Message          | string | Human-readable result summary.                           |

#### Generate Password Reset Link

Generate a one-time password reset link for a OneLogin user.

**Inputs**

| Field      | Type            | Required | Description                                                                              |
| ---------- | --------------- | -------- | ---------------------------------------------------------------------------------------- |
| User Email | select (string) | Yes      | Select the user, or type their email address. Options load from the selected connection. |

**Outputs**

| Field          | Type   | Description                                   |
| -------------- | ------ | --------------------------------------------- |
| Reset Link     | string | One-time password reset link for the user.    |
| Email          | string | Email of the user the link was generated for. |
| Result Message | string | Human-readable result summary.                |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/onelogin.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
