Skip to main content
Documentation
Documentation
Adaptive Planning
Last Updated: 2023-06-23
Permission Sets

Permission Sets

URL Endpoint

https://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/permissionSets
Version: v1
Category
Data Update
Description
Assign permission sets to Adaptive Planning Users.
Permission Required to Invoke
Admin Access
Users
,
Permission Sets
The Permission Set Assignment API enables you to retrieve and assign user permission sets.

Supported HTTPS VERBs:

HTTP Verb
Single Resource
Collection Resource
Description
GET
Not Supported
Supported
Retrieves all the users and their assigned permission sets.
POST
Supported
Supported
Adds a permission set or updates an existing permission set for a user.

GET

Request
/users/permissionSets
Retrieves a collection of permission sets assigned to users
Retrieves all users and their assigned permission sets. You can filter by instanceCode. If the instanceCode query parameter is missing, the API retrieves all users and their permission sets in your default instance. Pagination uses the default values for limit or offset if you don’t specify these query parameters.
Sample Request URI:
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/
Query Parameters:
Name
Description
Required
instanceCode
The unique identifier of an instance defining the instance context.
N
limit
The maximum number of objects in a single response. The default is 500. The maximum is 500.
N
offset
The zero-based index of the first user in a response collection. The default is 0.
Use offset with the limit parameter to control paging of a response collection.
N
Sample Response
Sample Response from an Instance User-synchronized with Workday
 


  "links": {
      "next": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=10&limit=5",
      "previous": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=0&limit=5"
  },{
  "total": 34,
  "users": [
      {
    "userGuid": "111SampleUserGuid",
    "wid": "14400000000000000000000000000samplewid",
    "userName": "sampleuser1@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "112SampleUserGuid",
    "wid": "24400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "113SampleUserGuid",
    "wid": "34400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 2,
        "name": "samplePermissionSet2"
      }
    ]
  },
      {
    "userGuid": "114SampleUserGuid",
    "wid": "44400000000000000000000000000samplewid",
    "userName": "sampleuser4@company.com",
    "permissionSet": [
      {
        "id": 3,
        "name": "samplePermissionSet3"
      }
    ]
  },
      {
    "userGuid": "115SampleUserGuid",
    "wid": "54400000000000000000000000000samplewid",
    "userName": "sampleuser5@company.com",
    "permissionSet": [
      {
        "id": 4,
        "name": "samplePermissionSet4"
      }
    ]
  }
]
}

POST:

Request:
/users/permissionSets:
Assigns or updates permission sets for users.
Adds a permission set or updates an existing permission set for a user. You can filter by instanceCode. If the instanceCode query parameter is missing, the API assigns the corresponding permission sets to all users in your default instance. In the request body, specify these required query fields: <userIdentifier> and permissionSet. To submit a bulk request for assigning corresponding permission sets to multiple users, specify an array containing each permission assignment.
Query Parameters:
Name
Description
Required
instanceCode
The unique identifier of an instance defining the instance context.
N
userIdentifier
The user identifier to determine the unique Adaptive Planning user ID. Possible values: userName, wid, userGuid.
Y
Sample Request:
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?userIdentifier=userName
Sample Request Body
Sample POST Request Body
 
[  
  {  
      "userName": "sampleuser1@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet1"
                  }
      ]
  },
  {
      "userName": "sampleuser2@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet2"
                  }
          ]
  },
  {
      "userName": "sampleuser3@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet3"
                  }
          ]
  }
]
PayLoad Parameters
Name
Description
Required
wid
The Workday ID of a user.
N
userName
The username (login name) of a user.
N
userGuid
The Global unique user identifier, system-assigned at creation.
N
name
id
Name of permissions set.
ID of permission set.
Either Name or ID of permission set is required.
Y