OneLogin
App Vendor: OneLogin
App Category: Identity Access Management
Connector Version: 1.0.0
API Version: v2
About App
The OneLogin app is a cloud-based identity and access management provider that develops a unified access management platform for enterprise-level businesses and organizations.
The OneLogin app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Get Multiple User Details | This action retrieves the details of multiple users. |
Get Role Admins | This action retrieves a list of users with the administrator role. |
Get Role Users | This action retrieves a list of users assigned to a specific role. |
Get User Details | This action retrieves the details of a user based on the specified ID. |
List Roles | This action retrieves a list of roles. |
List Users | This action retrieves the list of users. |
Update User | This action updates the attributes of a user in OneLogin, including passwords and custom attributes. |
Generic Action | This is a generic action used to make requests to any OneLogin endpoint. |
Configuration Parameters
The following configuration parameters are required for the OneLogin app to communicate with the OneLogin enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL. | Text | Required | |
Client ID | Enter the client ID. | Text | Required | |
Client Secret | Enter the client secret. | Password | Required | |
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with OneLogin. | Integer | Optional | Allowed Range: 15-120 Default value: 15 |
Verify | Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection. | Boolean | Optional | By default, verification is enabled. |
Action: Get Multiple User Details
This action retrieves the details of multiple users.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User Emails | Enter the list of email addresses to retrieve user details. | List | Required |
Example Request
[
{
"user_emails": [
"john.doe@sampleorg.com",
"jane.doe@sampleorg.com"
]
}
]Action: Get Role Admins
This action retrieves a list of users with the administrator role.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Role ID | Enter the role ID to retrieve the list of administrator users. Example: 747777 | Text | Required | You can retrieve this using the action List Roles. |
Example Request
[
{
"role_id": "747777"
}
]Action: Get Role Users
This action retrieves a list of users assigned to a specific role.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Role ID | Enter the role ID to retrieve the details of users assigned to that role. | Text | Required | You can retrieve this using the action List Roles. |
Example Request
[
{
"role_id": "747777"
}
]Action: Get User Details
This action retrieves the details of a user based on the specified ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to retrieve the user details. Example: 239440864. | Text | Required | You can retrieve this from the action List Users. |
Example Request
[
{
"user_id": "239787017"
}
]Action: List Roles
This action retrieves a list of roles.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Filters | Enter the filters to narrow down the response. | Key Value | Optional | Allowed keys: name, app_id, app_name, and fields |
Pagination | Select true to get the paginated data. | Boolean | Optional | Default value: false |
Example Request
[
{
"filters": {},
"pagination": true
}
]Action: List Users
This action retrieves the list of users.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Filters | Enter the filters to narrow down the response. | Key Value | Optional | Allowed keys: firstname, lastname, email, created_since, created_until, updated_since, updated_until, last_login_since, last_login_until, username, samaccountname, directory_id, external_id, app_id, user_ids, custom_attributes.{attribute_name}, fields |
Pagination | Select true to get the paginated data. | Boolean | Optional | Default value: false |
Example Request
[
{
"filters": {},
"pagination": true
}
]Action: Update User
This action updates the attributes of a user in OneLogin, including passwords and custom attributes.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the ID of the user that you want to update. | Text | Required | You can retrieve this using the action List Users. |
Payload | Enter the data to update user details. | Key Value | Required | Allowed keys: username, email, firstname, lastname, password, password_confirmation, password_algorithm, salt, title, department, company, comment, group_id, role_ids, phone, state, status, directory_id, trusted_idp_id, manager_ad_id, manager_user_id, samaccountname, member_of, userprincipalname, distinguished_name, external_id, openid_name, invalid_login_attempts, preferred_locale_code, custom_attributes For more information on the allowed values of the keys, see OneLogin API Documentation. |
Mapping | Specify how to apply the mappings to the user during an update. | Text | Optional | Allowed values: async: Mappings will run after the API returns a response, sync: Mappings will run before the API returns a response, disabled: Mappings will not run for this user Default value: async |
Validate Policy | Select true to validate passwords against the user policy. | Boolean | Optional | The default value is true. |
Example Request
[
{
"payload": {
"status": "0"
},
"user_id": "239787017"
}
]Action: Generic Action
This is a generic action used to make requests to any OneLogin endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to make the request. | Text | Required | Allowed values: GET, PUT, POST, PATCH, DELETE |
Endpoint | Enter the endpoint to make the request. Example: /roles | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key Value | Optional | Allowed keys: payload_json, custom_output, download, filename, files, retry_wait, retry_count, response_type |