This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/get-assetapi-user-settings.html.

`GET /assetapi/user/settings`

Overview

This API retrieves the app access information for all users in the specified Org.

Currently supported SnapLogic apps are:

IIP
AutoSync
Flows
Pattern Management

This API manages only the SnapLogic apps that the Org is subscribed to.

Prerequisites

Org Admin permissions

Request

Path Parameters

Key	Description

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

Query Parameters

Key	Type	Description

Key	Type	Description
`path`	string	Required. The path to the SnapLogic Org. Format: `/{org}`
`order_by`	string	A string comprised of: `+` for ascending order or `-` for descending order The field to sort by. Valid values: `username` `first_name` `last_name` `last_updated` `created` `ui_access` `disallowed_auth` `utility` Default: `+username` Examples: `+username` to sort by `username` in ascending order `-last_updated` to sort by `last_updated` in descending order
`offset`	integer	Returns a subset of the results starting at this 0-based index. You can use `limit` and `offset` for pagination. Default: 0
`limit`	integer	Returns no more than the specified number of results. You can use `limit` and `offset` for pagination. Valid values: 1 through 100,000 Default: 100

Request Header

Specify Basic for authorization and application/json for content type.

Request Body

None.

Response

Response Body

{
  "users": [
    {
      "username": ...,
      "first_name": ...,
      "last_name": ...,
      "last_updated": ...,
      "created": ...,
      "ui_access": true,
      "user_setting": {
        "app_access": {
          "myOrg": {
            "...": true,
            ...
          }
        }
      },
      "disallowed_auth": [ ... ],
      "utility": false
    },
    ...
  ]
}

Key	Type	Description

Key	Type	Description
`username` `first_name` `last_name`	string	User identification.
`last_updated` `created`	string	Dates when the app access information was updated and created, respectively.
`ui_access`	Boolean	If `true`, the user has access to the SnapLogic UI.
`user_setting » app_access`	object	Contains key-value pairs where the key is the Org name and the value is another object that contains the app names, each with a Boolean that indicates if the user has access to that app.
`disallowed_auth`	array	The list of disallowed authentication methods.
`utility`	Boolean	If `true`, the user account is a service account.

SnapLogic Documentation

Retrieve App Access Info