Initializing help system before first use

# UserAdmin Operations

insightapi2~create_authority_group | The payload specifies the attributes of the new authority groups. All other attributes are mandatory. Security: SYS_USER is required to create a new user.
insightapi2~create_sso_attribute_mapping | Create a mapping between authority groups and apps with an SSO attribute
insightapi2~create_user | Create a new user. Security: SYS_USER is required to create a new user and current user must be logged in locally.
insightapi2~delete_authority_group | Delete an authority group. Security: SYS_USER is required to delete an authority group.
insightapi2~delete_sso_attribute_mapping | Delete an SSO attribute mapping.
insightapi2~delete_user | Deletes a user by ID. Security: SYS_USER is required to delete a user and current user must be logged in locally.
insightapi2~get_authority_group | Get a single authority group by ID. Security: SYS_USER is required to read an authority group.
insightapi2~get_authority_groups | Get all authority groups. Security: SYS_USER is required to list authority groups.
insightapi2~get_custom_authorities | Get all custom authorities.
insightapi2~get_sso_attribute_mapping | Get an SSO attribute mapping by it's ID.
insightapi2~get_sso_attribute_mappings | List all of the current SSO attribute mappings.
insightapi2~get_user | Get a user by ID. Security: SYS_USER is required to read a user.
insightapi2~get_users | Get all users. Security: SYS_USER is required to list users.
insightapi2~update_authority_group | Update the properties of an authority group. Only the name, description and authorities can be changed. The objectType is optional, but if it is supplied then it must be AUTHORITY_GROUP. All other attributes are ignored. Security: SYS_USER is required to edit an authority group.
insightapi2~update_sso_attribute_mapping | Update the properties of an SSO attribute mapping
insightapi2~update_user | 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 status cannot be DELETED. 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. If authority groups are supplied, they will replace the existing ones. 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. Attempting to change the current user's status to a non ACTIVE status will result in a 422 error. Updating the current user's authority groups so that they no longer have the SYS_USER role will also result in a 422 error. Security: SYS_USER is required to edit a user.

Covered Topics

- insightapi2~create_authority_group
- insightapi2~create_sso_attribute_mapping
- insightapi2~create_user
- insightapi2~delete_authority_group
- insightapi2~delete_sso_attribute_mapping
- insightapi2~delete_user
- insightapi2~get_authority_group
- insightapi2~get_authority_groups
- insightapi2~get_custom_authorities
- insightapi2~get_sso_attribute_mapping
- insightapi2~get_sso_attribute_mappings
- insightapi2~get_user
- insightapi2~get_users
- insightapi2~update_authority_group
- insightapi2~update_sso_attribute_mapping
- insightapi2~update_user

Parent Topic Insight REST API client

© 2001-2026 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.