UserProvisioningLog Class

Provides methods for writing messages to monitor outbound user provisioning requests.

Namespace

UserProvisioning

Example

This example writes the user account information sent to a third-party system for a provisioning request to the UserProvisioningLog object.

String inputParamsStr = 'Input parameters: uprId=' + uprId + ', ​
endpointURL=' + endpointURL + ', adminUsername=' + adminUsername + ', ​
email=' + email + ', username=' + username + ', defaultPassword=' + defaultPassword + ', ​
defaultRoles =' + defaultRoles;
UserProvisioning.UserProvisioningLog.log(uprId, inputParamsStr);

UserProvisioningLog Methods

The following are methods for UserProvisioningLog. All methods are static.

log(userProvisioningRequestId, details)

Writes a specific message, such as an error message, to monitor the progress of a user provisioning request.

Signature

public void log(String userProvisioningRequestId, String details)

Parameters

userProvisioningRequestId
Type: String
A unique identifier for the user provisioning request.
details
Type: String
The text for the message.

Return Value

Type: void

log(userProvisioningRequestId, status, details)

Writes a specific status and message, such a status and detailed error message, to monitor the progress of a user provisioning request.

Signature

public void log(String userProvisioningRequestId, String status, String details)

Parameters

userProvisioningRequestId
Type: String
A unique identifier for the user provisioning request.
status
Type: String
A description of the current state. For example, while invoking a third-party API, the status could be invoke.
details
Type: String
The text for the message.

Return Value

Type: void

log(userProvisioningRequestId, externalUserId, externalUserName, userId, details)

Writes a specific message, such as an error message, to monitor the progress of a user provisioning request associated with a specific user.

Signature

public void log(String userProvisioningRequestId, String externalUserId, String externalUserName, String userId, String details)

Parameters

userProvisioningRequestId
Type: String
A unique identifier for the user provisioning request.
externalUserId
Type: String
The unique identifier for the user in the target system.
externalUserName
Type: String
The username for the user in the target system.
userId
Type: String
Salesforce ID of the user making the request.
details
Type: String
The text for the message.

Return Value

Type: void