Click or drag to resize

IASessionAddIdentity Method

Adds an identity.

Namespace:  Koopman.CheckPoint.IA
Assembly:  CheckPoint.NET (in CheckPoint.NET.dll) Version: 0.5.1
Syntax
C#
Copy
public Task<AddIdentityResponse> AddIdentity(
	string ipAddress,
	string user = null,
	string machine = null,
	string domain = null,
	int sessionTimeout = 43200,
	Nullable<bool> fetchUserGroups = null,
	Nullable<bool> fetchMachineGroups = null,
	Nullable<bool> calculateRoles = null,
	string[] userGroups = null,
	string[] machineGroups = null,
	string[] roles = null,
	string machineOS = null,
	string hostType = null,
	CancellationToken cancellationToken = null
)
Request Example View Source

Parameters

ipAddress
Type: SystemString
The ip address.
user (Optional)
Type: SystemString
The user.
machine (Optional)
Type: SystemString
The machine.
domain (Optional)
Type: SystemString
The domain.
sessionTimeout (Optional)
Type: SystemInt32
The session timeout.
fetchUserGroups (Optional)
Type: SystemNullableBoolean
Weather to automatically fetch user groups.
fetchMachineGroups (Optional)
Type: SystemNullableBoolean
Weather to automatically fetch machine groups.
calculateRoles (Optional)
Type: SystemNullableBoolean
Weather to automatically calculate roles.
userGroups (Optional)
Type: SystemString
The user groups.
machineGroups (Optional)
Type: SystemString
The machine groups.
roles (Optional)
Type: SystemString
The roles.
machineOS (Optional)
Type: SystemString
The machine os.
hostType (Optional)
Type: SystemString
Type of the host.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskAddIdentityResponse
A task that represents the asynchronous operation. The task result contains will contain null if you have started a batch processing with StartAddBatch(ActionAddIdentityResponse, Int32), otherwise it will contain the response from the gateway.
See Also