User administration
| Operation | Description |
|---|---|
| GET /insightservices/rest/v1/admin/authority-group | Get all authority groups |
| POST /insightservices/rest/v1/admin/authority-group | Create a new authority group |
| GET /insightservices/rest/v1/admin/authority-group/{authorityGroupId} | Get an authority group |
| POST /insightservices/rest/v1/admin/authority-group/{authorityGroupId} | Update an authority group |
| DELETE /insightservices/rest/v1/admin/authority-group/{authorityGroupId} | Delete an authority group |
| GET /insightservices/rest/v1/admin/custom-authority | getCustomAuthorities |
| GET /insightservices/rest/v1/admin/user | Get all users |
| POST /insightservices/rest/v1/admin/user | Create a new user |
| GET /insightservices/rest/v1/admin/user/{userId} | Get a user |
| POST /insightservices/rest/v1/admin/user/{userId} | Update a user |
| DELETE /insightservices/rest/v1/admin/user/{userId} | deleteUser |
GET /insightservices/rest/v1/admin/user
Security: SYS_USER is required to list users.
Responses
application/json
- 200 OK
-
Type: WebServiceBeanListV1«UserV1»
Responds with all users in the system, sorted by name
- 403 Forbidden
-
The current user is not authorized to list users
POST /insightservices/rest/v1/admin/user
The payload specifies the attributes of the new user. The username, first name and last name is mandatory. The user will be granted membership to the supplied list of apps, if supplied. The objectType attribute is optional but must be USER if supplied. All other attributes are ignored. Security: SYS_USER is required to create a new user.
Request Body
application/json
Type: UserV1
user
Responses
application/json
- 200 OK
-
Type: UserV1
Responds with the successfully created user
- 403 Forbidden
-
The current user is not authorized to create users
- 422 Unprocessable Entity
-
The supplied payload was invalid
GET /insightservices/rest/v1/admin/user/{userId}
Security: SYS_USER is required to read a user.
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| userId | userId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: UserV1
Responds with the retrieved user
- 403 Forbidden
-
The current user is not authorized to read this user
- 404 Not Found
-
The requested user is unavailable to the current user
POST /insightservices/rest/v1/admin/user/{userId}
The payload contains the updates to apply to the user. They are all optional. The first name, last name, email and status fields are optional. The user id attribute is optional, but if it is supplied then it must match the id in the URL. The user's app membership will be updated to the supplied list of apps. Their membership is unchanged if this attribute is missing or null. The objectType is optional, but if it is supplied then it must be USER. All other attributes are ignored. When using SAML2 authentication, the first name, last name, email and status fields can only be edited in the Identity Provider - if specified here they will be ignored.Security: SYS_USER is required to edit a user.
Request Body
application/json
Type: UserV1
user
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| userId | userId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Type: UserV1
Responds with the successfully updated user
- 403 Forbidden
-
The current user is not authorized to update this user
- 404 Not Found
-
The requested user is unavailable to the current user
- 422 Unprocessable Entity
-
Validation of the requested changes failed. e.g. the displayName was too long or an app does not exist
DELETE /insightservices/rest/v1/admin/user/{userId}
Request Parameters
| Name | Description | Type | Data Type | |
|---|---|---|---|---|
| userId | userId |
path | string (uuid) | required |
Responses
application/json
- 200 OK
-
Responds with the successfully deleted user
- 204 No Content
-
No Content
- 403 Forbidden
-
The current user is not authorized to delete this user
- 404 Not Found
-
The requested user is unavailable to the current user
Properties
- objectType: string , x ∈ { AUTHORITY_GROUP }
-
- id: string
-
The id of this authority group
Example: "6afd72b3-8762-4648-a69a-bc558eef1aa8" - displayName: string
-
The name of this authority group
Example: "Manager authorities" - description: string
-
The description of this authority group
Example: "Default group of authorities assigned to managers" - authorities: string[]
-
The authorities in this group
Array of string , x ∈ { PROJECT_ALL , PROJECT_ATTACHMENT_EDIT , PROJECT_ATTACHMENT_VIEW , PROJECT_DELETE , PROJECT_EDIT , PROJECT_NEW , DEVELOPER , DIRECT_DATA_VIEW , FOLDER_DELETE , FOLDER_EDIT , FOLDER_NEW , FOLDER_OWNER , FOLDER_SHARE , SCENARIO_ALL , SCENARIO_ATTACHMENT_EDIT , SCENARIO_DELETE , SCENARIO_EDIT , SCENARIO_EXEC , SCENARIO_NEW , SCENARIO_OWNER , SCENARIO_SHARE , SYS_IMPORTEXPORT , SYS_SERVER , SYS_SERVICES , SYS_SESSIONS , SYS_USER , WORKBOOK_PUBLISH } - url: string
-
The URL of this authority group
Example: "/insightservices/rest/v1/admin/authority-group/6afd72b3-8762-4648-a69a-bc558eef1aa8" - customAuthorities: object[]
-
The custom authorities in this group
Array of CustomAuthorityV1
Properties
- objectType: string , x ∈ { SCENARIO , PROJECT , MODEL_SCHEMA , USER , PROJECT_USER , VIRTUAL_SCENARIO_GROUP , EXECUTION_STATUS , EXECUTION_REQUEST , FOLDER , VIEW , TABLEAU_WORKBOOK , SCENARIO_RUN_LOG , ATTACHMENT , EXECUTION_WORKER , EXECUTION_SERVICE , EXECUTION_WORKER_MAPPING , AUTHORITY_GROUP , USER_PROFILE , PORTATION , MIRROR_REQUEST , MIRROR_REQUEST_STATUS , MIRROR_DESCRIPTOR_STATUS , COMPUTE_JOB }
-
The type of object
Example: "SCENARIO" - id: string
-
The id of this item
Example: "21384a4b-2c4a-4ce2-9f78-87c967ebe06e" - displayName: string
-
The name of this item
Example: "Item name" - url: string
-
The URL of this item
Example: "/insightservices/rest/v1/item/21384a4b-2c4a-4ce2-9f78-87c967ebe06e"
Properties
- email: string
-
- enabled: boolean
-
- locked: boolean
-
- objectType: string , x ∈ { USER }
-
- password: string
-
- status: string , x ∈ { DELETED , DISABLED , LOCKED , ACTIVE }
-
- tableauEnabled: boolean
-
- id: string
-
The id of this user
Example: "8cf6406a-6e43-402b-95eb-c0a47f8791cc" - username: string
-
Example: "bill.gates" - firstName: string
-
Example: "William" - lastName: string
-
Example: "Gates" - displayName: string
-
Example: "William Gates" - apps: object[]
-
Projects that this user is a member of - must have objectType PROJECT
Array of SimpleReferenceV1 - authorityGroups: object[]
-
Authority groups that this user is a member of
Array of AuthorityGroupV1 - url: string
-
The URL of this user
Example: "/insightservices/rest/v1/admin/user/8cf6406a-6e43-402b-95eb-c0a47f8791cc"
Properties
- start: integer (int32)
-
The start position of this list
Example: 2 - maxResults: integer (int32)
-
The maximum number of items to include in this list
Example: 7 - items: object[]
-
The items in this list
Array of AuthorityGroupV1
Properties
- start: integer (int32)
-
The start position of this list
Example: 2 - maxResults: integer (int32)
-
The maximum number of items to include in this list
Example: 7 - items: object[]
-
The items in this list
Array of CustomAuthorityV1
Properties
- start: integer (int32)
-
The start position of this list
Example: 2 - maxResults: integer (int32)
-
The maximum number of items to include in this list
Example: 7 - items: object[]
-
The items in this list
Array of UserV1
© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.