Deletes a platform role that already exists. Since the platform requires IT users to have a single role, you need to specify a new role to grant to the users that are currently set with the role you want to delete.

Input parameters

Authentication: WebServiceSimpleAuthentication Record type.
The authentication required to use this API. Specify a valid platform username and password, or use the AuthenticationService API to acquire a session token.

RoleName: Text type.
The name of the platform role.

UserNewRole: Text type.
A role to grant to the users that had the role that is going to be deleted.

Output parameters

Success: Boolean type.
True if the method was successful, False otherwise.

Status: APIStatus Record type.
The status of invoking this API action. In case of error, contains the error code and human-readable error messages.

AffectedPlatformUsers: PlatformUser Record List type.
The list of IT users that had the deleted role assigned to them.

See Also

Overview of LifeTime Services API | Authentication_GetToken Action