HID Global

https://docs.hidglobal.com
Admin
HID Global provides identity and access management solutions, multi-factor authentication,...
Tokens:2,024,477
Snippets:22,565
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Installation with Feature Removal

Source: https://docs.hidglobal.com/digitalpersona-v4.4.0/ad/deploy/install-workstation.htm

An example command to install all default features while specifically excluding the Logon component.

```bash
msiexec /i setup.msi    ADDLOCAL=ALL REMOVE=Logon
```

--------------------------------

### Install DigitalPersona LDS with Specific Component Exclusions

Source: https://docs.hidglobal.com/digitalpersona-v4.4.0/lds/deploy/install-dplds.htm

Example of installing all features while explicitly removing specific components like STS and the Web Administrative Console.

```bash
msiexec /i setup.msi    ADDLOCAL=ALL REMOVE=STS,WebAdminConsole
```

--------------------------------

### Authenticator GET Responses

Source: https://docs.hidglobal.com/dev/scim/v4/ActivID-OpenAPI-SCIM-4.0.yaml

Examples of GET responses for different types of authenticators.

```yaml
    Authenticator_Password_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
          - urn:hid:scim:api:idp:2.0:Password
        id: 11288.AT_CUSTPW
        externalId: jdoe
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11288.AT_CUSTPW
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: user12345
          value: 12345
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/12345
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_CUSTPW
          value: AT_CUSTPW
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Policy/Authenticator/AT_CUSTPW
        urn:hid:scim:api:idp:2.0:Password:
          username: user1235
```

```yaml
    Authenticator_LDAP_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
        id: 11324.AT_LDAP
        externalId: LDAP_USER_009
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11324.AT_LDAP
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: LDAP_USER_009
          value: 11324
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/11324
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_LDAP
          value: AT_LDAP
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Policy/Authenticator/AT_LDAP
```

```yaml
    Authenticator_Device_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
        id: 11288.AT_CUSTOTP
        externalId: jdoe
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11288.AT_CUSTOTP
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: user12345
          value: 12345
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/12345
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_CUSTOTP
          value: AT_CUSTOTP
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Policy/Authenticator/AT_CUSTOTP
```

```yaml
    Authenticator_SQ_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
        id: 11288.AT_CUSTQA
        externalId: jdoe
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11288.AT_CUSTQA
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: user12345
          value: 12345
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/12345
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_CUSTQA
          value: AT_CUSTQA
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Policy/Authenticator/AT_CUSTQA
        urn:hid:scim:api:idp:2.0:SecurityQuestion:
          prompts:
            - prompt:
                display: Your oldest sibling's middle name
                value: PR_SIBLING
            - prompt:
                display: Childhood nickname
```

--------------------------------

### String Configuration Examples

Source: https://docs.hidglobal.com/dev/openid/v1/ActivID-OpenAPI-OpenID-1.0.3.yaml

Examples for client secret and login URI configuration.

```json
password01
```

```json
http://localhost/
```

--------------------------------

### Certificate Status Request Example

Source: https://docs.hidglobal.com/validation-authority-v7.5/docs/management-console/api-get-certificate-status.htm

A concrete example of a GET request to the API.

```http
https://localdomain:3601/rest/credential/CN=VATEST-WIN-K15LUPAUVSLF-CA,%20DC=VATEET,%20DC=org/0xAA11100
```

--------------------------------

### Example Provisioning Protocol Settings

Source: https://docs.hidglobal.com/dev/scim/v10/ActivID-OpenAPI-SCIM-10.2.0.yaml

Examples for provisioning protocol version and KDF length.

```json
v5
```

```json
10
```

--------------------------------

### Permission Set Management

Source: https://docs.hidglobal.com/dev/scim/v11/ActivID-OpenAPI-SCIM-11.1.0.yaml

Examples of GET, PUT, and GET ALL operations for permission sets.

```yaml
    PermissionSet_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:PermissionSet
        id: FS_RLASG
        meta:
          resourceType: PermissionSet
          location: https://server.example.com:8445/scim/tenantexample/v2/PermissionSets/FS_RLASG
          version: '1'
        permissionSetItems:
          - schemas:
            - urn:hid:scim:api:idp:2.0:PermissionSetItem
            id: M_U_ROLES
            parameter: RL_DEVADM|RL_SYSTEM|RL_RFE|RL_USERADM|RL_AUDITV|RL_CONFIG|RL_HELPDSK|RL_SUSRADM|RL_SADMIN|RL_STPADM|RL_SSPADM|RL_RGWADM|RL_CFGMGR
        name: Roles Assignment Functions
        resourceType: GROUP
```

```yaml
    PermissionSet_PUT:
      value:
        id: FS_RLASG
        permissionSetItems:
            id: M_U_ROLES
            parameter: RL_DEVADM|RL_SYSTEM|RL_RFE|RL_USERADM|RL_AUDITV|RL_CONFIG|RL_HELPDSK|RL_SUSRADM|RL_SADMIN|RL_STPADM|RL_SSPADM|RL_RGWADM|RL_CFGMGR
```

```yaml
    PermissionSet_GETALL:
      value:
        schemas:
          - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults: 1
        resources:
          - schemas:
            - urn:hid:scim:api:idp:2.0:PermissionSet
            id: FS_RLASG
```

--------------------------------

### Sample Configuration File

Source: https://docs.hidglobal.com/digitalpersona-v4.4.0/ad/admin/customize-enrollment.htm

A complete example of the appSettings section in the DPAdminUI/AppSettings.config file including the new fingerprint approval keys.

```xml
<?xml version="1.0"?>  
<appSettings>  
  <add key="userCount" value="50" />  
  <add key="approvalWorkflow" value="false" />  
  <add key="approvalWorkflowFp" value="true" />  
  <add key="approvalWorkflowNumFp" value="3" />  
  <add key="wsFederationMetadataAddress" value="https://websts.igorm.testdomain.com/dppassivests/wsfed/metadata" />  
  <add key="wsFederationWtrealm" value="urn:webadmin" />  
  <add key="dataProtectionCertificateThumbprint" value="38F139B3CC04BBAB823B691F192DE42CA8E2AAAC" />  
  <add key="wsFederationWreply" value="https://webadmin.igorm.testdomain.com/dpadminui" />  
  <add key="enrollUrl" value="https://webaccess.igorm.testdomain.com/DPWebEnroll/DPWebEnrollService.svc" />  
  <add key="authUrl" value="https://webaccess.igorm.testdomain.com/DPWebAUTH/DPWebAuthService.svc" />  
  <add key="policyUrl" value="https://webaccess.igorm.testdomain.com/DPWebPolicies/DPWebPolicyService.svc" />  
  <add key="adminUrl" value="https://webaccess.igorm.testdomain.com/DPWebAdmin/DPWebAdminService.svc" />  
  <add key="webEnrollmentUri" value="https://webenroll.igorm.testdomain.com/dpenrollment" />  
  <add key="delegatedAdminGroups" value="*" />  
  <add key="searchBaseDN" value="CN=Users,DC=IgorM,DC=TestDomain,DC=com" />  
</appSettings>
```

--------------------------------

### Configure Server Startup

Source: https://docs.hidglobal.com/activid-cms-v6.5/operator/hsm/entrust-datacard/set-up-nshield-connect.htm

Enable the TCP socket for Java and KeySafe.

```bash
C:\Program Files\nCipher\nfast\bin\config-serverstartup –sp
```

--------------------------------

### Authenticator GET Payloads

Source: https://docs.hidglobal.com/dev/scim/v7/ActivID-OpenAPI-SCIM-7.0.0.yaml

Examples of GET responses for Password and LDAP type authenticators.

```yaml
    Authenticator_Password_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
          - urn:hid:scim:api:idp:2.0:Password
        id: 11288.AT_CUSTPW
        externalId: jdoe
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11288.AT_CUSTPW
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: user12345
          value: 12345
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/12345
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_CUSTPW
          value: AT_CUSTPW
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Policy/Authenticator/AT_CUSTPW
        urn:hid:scim:api:idp:2.0:Password:
          username: user1235
```

```yaml
    Authenticator_LDAP_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
        id: 11324.AT_LDAP
        externalId: LDAP_USER_009
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11324.AT_LDAP
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: LDAP_USER_009
          value: 11324
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/11324
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_LDAP
          value: AT_LDAP
```

--------------------------------

### Get Authenticator Request URI

Source: https://docs.hidglobal.com/activid-appliance-v8.7/api/scim/authenticator-rest-api.htm

Example of the GET request URI structure for retrieving an authenticator.

```http
[GET] /scim/{tenant}/v2/Authenticator/10033.AT_EMPOTP
```

--------------------------------

### Install FIDO Provisioning via Command Line

Source: https://docs.hidglobal.com/customercentral/dm-requests-create.htm

Use these commands with administrator privileges to install the application.

```bash
 "HID FIDO Provisioning Setup.exe" --install
```

```bash
 "HID FIDO Provisioning Setup.exe" -i
```

--------------------------------

### Install dependencies on Red Hat systems

Source: https://docs.hidglobal.com/crescendo-pkcs11/crescendo_p11/html/USAGE.html

Install required libraries and start the pcscd service.

```bash
dnf install pcsc-lite pcsc-lite-libs libstdc++
systemctl start pcscd.service
```

--------------------------------

### Install HID Authentication Device Client via Command Line

Source: https://docs.hidglobal.com/digitalpersona-v4.4.0/ad/deploy/install-adc.htm

Use the msiexec command to install the software, optionally specifying the installation directory, components, and silent installation mode.

```bash
msiexec /i setup.msi [INSTALLDIR=”<directory>”] [ADDLOCAL=<software>] [BIOMETRICDATA=<location>] [REMOVE=<software>] [TRANSFORMS=<list of transform files>] [/qn] [other MSIEXEC options]
```

--------------------------------

### Provisioning and Container Creation

Source: https://docs.hidglobal.com/hid-approve-sdk/migrate/migratesdk-ios.htm

Examples for handling progress events and container initialization during the provisioning process.

```objective-c
// progress listener  
-(void)onEventReceived:(id<HIDProgressEvent>)event {  
	NSArray* params = [event parameters];  
	NSString* message; NSString* percent;  
	for (HIDParameter* p in params) {  
		if ( [[p key] caseInsensitiveCompare:HID_PARAM_PROGRESSEVENT_MESSAGE]==NSOrderedSame)  
			message = [p value];  
		if ( [[p key] caseInsensitiveCompare:HID_PARAM_PROGRESSEVENT_PERCENT]==NSOrderedSame)  
			percent = [p value];  
	}  
	NSString* text = [NSString stringWithFormat:@"%@ (%@)", message, percent];  
	NSLog(@"Event Received: %@", text);  
}  
// provisioning  
-(void)doProvisioning {  
	NSError* error;  
	// get device  
	HIDConnectionConfiguration* connectionConfig = [[HIDConnectionConfiguration alloc] init];  
	id<HIDDevice> pDevice = [[HIDDeviceFactory alloc] newInstance:connectionConfig error:&error];  
	// new container  
	HIDContainerInitialization* config = [[HIDContainerInitialization alloc] init];  
	config.activationCode = [[NSString alloc] initWithData:myActivationCodeData encoding:NSUTF8StringEncoding];  
	config.initialPassword = myInitialPassword;  
	config.pushId = myPushID;  
	config.containerFriendlyName = myServiceName;  
	id<HIDContainer> pContainer = [pDevice createContainer:config withListener:self error:&error];  
}
```

```objective-c
// progress listener  
-( HIDEventResult*)onEventReceived:(NSObject<HIDEvent>*)event {  
	if ([event isKindOfClass:[HIDPasswordPromptEvent class]]) {  
		// password request  
		HIDPasswordPromptEvent* pPwdEvent = (HIDPasswordPromptEvent*)event;  
		return [[HIDPasswordPromptResult alloc] initWithCode:Continue andPassword:myInitialPassword];  
	}  
	else { // progress message  
		NSArray* params = [event parameters];  
		NSString* message; NSString* percent;  
		for (HIDParameter* p in params) {  
			if ( [[p key] caseInsensitiveCompare:HID_PARAM_PROGRESSEVENT_MESSAGE]==NSOrderedSame)  
				message = [p value];  
			if ( [[p key] caseInsensitiveCompare:HID_PARAM_PROGRESSEVENT_PERCENT]==NSOrderedSame)  
				percent = [p value];  
		}  
		NSString* text = [NSString stringWithFormat:@"%@ (%@)", message, percent];  
		NSLog(@"Event Received: %@", text);  
	}  
	return [[HIDEventResult alloc] initWithCode:(Continue)];  
}  
// provisioning  
-(void)doProvisioning {  
	NSError* error;  
	// get device  
	HIDConnectionConfiguration* connectionConfig = [[HIDConnectionConfiguration alloc] init];  
	id<HIDDevice> pDevice = [[HIDDeviceFactory alloc] newInstance:connectionConfig withSessionPassword:mySessionPwd error:&error];  
	// new container  
	HIDContainerInitialization* config = [[HIDContainerInitialization alloc] init];  
	config.activationCode = [[NSString alloc] initWithData:myActivationCodeData encoding:NSUTF8StringEncoding];  
	// NOTE: “config.initialPassword” is not supported; use listener  
	config.pushId = myPushID;  
	config.containerFriendlyName = myServiceName;  
	id<HIDContainer> pContainer = [pDevice createContainer:config withSessionPassword:mySessionPwd withListener:self error:&error];  
}
```

--------------------------------

### Get Client Response Example

Source: https://docs.hidglobal.com/dev/openid/v1/ActivID-OpenAPI-OpenID-1.0.3.yaml

Example of a successful client retrieval response containing redirect URIs.

```json
- https://client.example.org/callback
- https://client.example.org/callback2
```

--------------------------------

### Authenticator GET Responses

Source: https://docs.hidglobal.com/dev/scim/v6/ActivID-OpenAPI-SCIM-6.0.0.yaml

Examples of GET responses for different types of authenticators including Password, LDAP, and Device.

```json
    Authenticator_Password_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
          - urn:hid:scim:api:idp:2.0:Password
        id: 11288.AT_CUSTPW
        externalId: jdoe
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11288.AT_CUSTPW
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: user12345
          value: 12345
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/12345
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_CUSTPW
          value: AT_CUSTPW
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Policy/Authenticator/AT_CUSTPW
        urn:hid:scim:api:idp:2.0:Password:
          username: user1235
```

```json
    Authenticator_LDAP_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
        id: 11324.AT_LDAP
        externalId: LDAP_USER_009
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11324.AT_LDAP
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: LDAP_USER_009
          value: 11324
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/11324
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_LDAP
          value: AT_LDAP
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Policy/Authenticator/AT_LDAP
```

```json
    Authenticator_Device_GET:
      value:
        schemas:
          - urn:hid:scim:api:idp:2.0:Authenticator
        id: 11288.AT_CUSTOTP
        externalId: jdoe
        meta:
          resourceType: Authenticator
          created: 2015-05-15T18:15:21+00:00
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Authenticator/11288.AT_CUSTOTP
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: user12345
          value: 12345
          location: https://server.example.com:8445/scim/t30a7090b6259296697652/v2/Users/12345
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
```

--------------------------------

### XAUTH Authentication Examples

Source: https://docs.hidglobal.com/crescendo-sdk/API%20references/html/index.html

Demonstrates providing an XAUTH key directly or via an environment variable.

```bash
CrescendoCLI.exe <command> --xauth-key 0123456789ABCDEF
```

```bash
CrescendoCLI.exe <command> --xauth-key env
```

--------------------------------

### Example Key Configuration Output

Source: https://docs.hidglobal.com/activid-as-v8.6/Procedures/ops/as/manage-crypto.htm

Sample output showing the current cryptographic key settings loaded from the configuration file.

```text
Working in SOFT mode.  
 
This is the current cryptographic keys settings from configuration file content.  
Warning: the configuration is loaded when server starts.  
Please ensure you have restarted the server since the last configuration change.  
 
Current configuration:  
 
Default keys:  
Default key set is using configured level equal to 2  
		hid-ia-4t.audit.2  
		hid-ia-4t.dsign.2  
		hid-ia-4t.sys.2  
		hid-ia-4t.creds.2  
		hid-ia-4t.session.2  
--> Default keys are ok  
 
Default keys for domain ONLINEBANK:  
Domain is configured to support shared keys with level equal to 1  
		hid-ia-4t.audit.1  
		hid-ia-4t.dsign.1  
		hid-ia-4t.sys.1  
		hid-ia-4t.creds.1  
		hid-ia-4t.session.1  
--> Default keys for domain ONLINEBANK are ok
```

--------------------------------

### Get Audit Records Request URI

Source: https://docs.hidglobal.com/dev/auth-service/api/audit-records-rest-api.htm

Example URI structure for retrieving audit records via GET.

```http
[GET] /scim/{tenant}/v2/AuditRecords
```

--------------------------------

### Provisioning Protocol Configuration Example

Source: https://docs.hidglobal.com/dev/scim/v8/ActivID-OpenAPI-SCIM-8.0.0.yaml

Example values for provisioning protocol parameters including version, key derivation length, and character set.

```yaml
version:
  description: Defines the minimum version of the provisioning protocol supported by the server.
  type: string
  example: v5
kdfLen:
  description: Defines the length used to compute pss (pre-shared secret).
  type: integer
  format: int32
  example: 10
  minimum: 1
kdfCharset:
  description: |
      Defines the char set used to compute pss (pre-shared secret).
      * ALPHA : Only uppercase or numeric characters.
      * ASCII : the ASCII "94" char set (ASCII printable characters from 0 to 126).
  type: string
  example: ASCII
pushNotif:
  description: Enable or disable sending notification when creating a push transaction.
  type: boolean
  example: true
```

--------------------------------

### Sample GET Request for Import Status

Source: https://docs.hidglobal.com/activid-appliance-v8.7/api/scim/users-rest-api.htm

An example of a GET request to retrieve the status of a specific import job.

```http
GET /scim/{tenant}/v2/Users/.import/1P5FOESDK44J6Q0QAHK2
```

--------------------------------

### Update Scheduler Examples

Source: https://docs.hidglobal.com/activid-as-v8.6/Procedures/ops/as/archive_audit.htm

Various examples demonstrating how to configure the schedule for audit, challenge, and session record tasks.

```bash
su - ftadmin -c "<ACTIVID_HOME>/ActivID_AS/bin/updateScheduler.sh -d ONLINEBANK"
```

```bash
su - ftadmin -c "<ACTIVID_HOME>/ActivID_AS/bin/updateScheduler.sh -d ONLINEBANK -a 5 -c 7 –s 8"
```

```bash
su - ftadmin -c "<ACTIVID_HOME>/ActivID_AS/bin/updateScheduler.sh -d ONLINEBANK -a 5 -c 7"
```

```bash
su - ftadmin -c "<ACTIVID_HOME>/ActivID_AS/bin/updateScheduler.sh -d ONLINEBANK -a 5"
```

```bash
su - ftadmin -c "<ACTIVID_HOME>/ActivID_AS/bin/updateScheduler.sh -d ONLINEBANK -s 9"
```

--------------------------------

### Logout Request Examples

Source: https://docs.hidglobal.com/dev/auth-service/api/logout-endpoint.htm

Examples of performing a logout using either GET or POST methods with required parameters.

```http
GET https://[base-server-url]/idp/{tenant}/authn/logout?post_logout_redirect_uri=https://client.example.org/logout&id_token_hint=eyJraWQiOiItMTQ5NzQxMDcwMSIsIng1dCI6IjU5ai1pSVBzY2ZXUm5ITVFHSEdnb0pEQXIwUSIsImFsZyI6IlJTMjU2In0.eyJleHAiOjE3MTMyOTQ3NjAsIm5iZiI6MTcxMzI5MTE2MCwianRpIjoiODZmYjk3NGQtNzVlZC00Zjk1LThlY2UtYWRiNmY4MmVhZmRmIiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi1kZW1vLmN1cml0eS5pby9vYXV0aC92Mi9vYXV0aC1hbm9ueW1vdXMiLCJhdWQiOiJkZW1vLXdlYi1jbGllbnQiLCJzdWIiOiJob25nIiwiYXV0aF90aW1lIjoxNzEzMjkxMTUwLCJpYXQiOjE3MTMyOTExNjAsInB1cnBvc2UiOiJpZCIsImF0X2hhc2giOiJLVU5mYmM0Vjc2UEFFb0Zucnpqa2tnIiwiYWNyIjoidXJuOnNlOmN1cml0eTphdXRoZW50aWNhdGlvbjp1c2VybmFtZTp1c2VybmFtZSIsImRlbGVnYXRpb25faWQiOiI2ZTU0ZjUzYS1lNjk5LTRhOWYtOTI2MS0zMjc4ZWNhYjg5NjAiLCJzX2hhc2giOiJNR0NaZkRGaVBtcFdyX2RoTHBSc0l3IiwiYXpwIjoiZGVtby13ZWItY2xpZW50IiwiYW1yIjoidXJuOnNlOmN1cml0eTphdXRoZW50aWNhdGlvbjp1c2VybmFtZTp1c2VybmFtZSIsIm5vbmNlIjoiNzMxMTM0NzgwMnM0Ny1meGQiLCJzaWQiOiJ2Nlg0RUsxdmJXelhtdmMyIn0.JuR7yL9-JFUC2VwvJa-UjsJIL_83LqVWXYgdt7qQT9m-dtWBSTKP06DCuL-QHfmU_rvCLJ8i3-ORGmSlXiAYD20LLenpUoFrUnLdsDR1OD9pLNdPG8PF24XABs-KN8XKJQt002iwrxvx5v0Xkl8iPsSuA9qYBDOjzw7rkCi-4Zdde5zu7C4_0ebg5ArUBdvQY_d-o0-a5n8WXQtOlk2GVZAt0aDeGaoc3Cjs2uaL2VbuLlQvHJK3FNg0rMxqtNdtNTgcnpCCBmMYB6dIoas0-k10C0lbncIhbjYZj59DbCWLVZJZ5HunG9zUwIv9srRpZzwoxbAOwEDcdMuSq-vhVVO5Yv23wv8Vb9FpIEjgR4MmfIZ96Ji1QBaHy9FNAvD_Nq3GdDjjzp4Z_wV_uPLec2oKwsio1ZJ8LGB07mvxifASgx7276ZgJcG6NQFtB5os598HZBOE_ClzuzwKD8repwJGSsrtL33teJUkPVlnZJyzZAzLeZzkNoztAN9ye24YQo_GXWBWwRAVjFG-DnzjjL8ChvOo5DbWaD3dnUL2Iz5I8XZhFj-oKr4-8X1XGJXTkiNQ4HnWJcJ0VG2hVIoWs45KL3oX5i8wbBS7wj5BzzlyucZ8t9ERMV-hzZ9ZoycU0-_ur_KPWET8BJp8MvDb1Uukz7cfKPxMNkj0vUR6lqc&state=toto
```

```http
POST https://[base-server-url]/idp/{tenant}/authn/logout HTTP/1.1
post_logout_redirect_uri=https://client.example.org/logout&id_token_hint=eyJraWQiOiItMTQ5NzQxMDcwMSIsIng1dCI6IjU5ai1pSVBzY2ZXUm5ITVFHSEdnb0pEQXIwUSIsImFsZyI6IlJTMjU2In0.eyJleHAiOjE3MTMyOTQ3NjAsIm5iZiI6MTcxMzI5MTE2MCwianRpIjoiODZmYjk3NGQtNzVlZC00Zjk1LThlY2UtYWRiNmY4MmVhZmRmIiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi1kZW1vLmN1cml0eS5pby9vYXV0aC92Mi9vYXV0aC1hbm9ueW1vdXMiLCJhdWQiOiJkZW1vLXdlYi1jbGllbnQiLCJzdWIiOiJob25nIiwiYXV0aF90aW1lIjoxNzEzMjkxMTUwLCJpYXQiOjE3MTMyOTExNjAsInB1cnBvc2UiOiJpZCIsImF0X2hhc2giOiJLVU5mYmM0Vjc2UEFFb0Zucnpqa2tnIiwiYWNyIjoidXJuOnNlOmN1cml0eTphdXRoZW50aWNhdGlvbjp1c2VybmFtZTp1c2VybmFtZSIsImRlbGVnYXRpb25faWQiOiI2ZTU0ZjUzYS1lNjk5LTRhOWYtOTI2MS0zMjc4ZWNhYjg5NjAiLCJzX2hhc2giOiJNR0NaZkRGaVBtcFdyX2RoTHBSc0l3IiwiYXpwIjoiZGVtby13ZWItY2xpZW50IiwiYW1yIjoidXJuOnNlOmN1cml0eTphdXRoZW50aWNhdGlvbjp1c2VybmFtZTp1c2VybmFtZSIsIm5vbmNlIjoiNzMxMTM0NzgwMnM0Ny1meGQiLCJzaWQiOiJ2Nlg0RUsxdmJXelhtdmMyIn0.JuR7yL9-JFUC2VwvJa-UjsJIL_83LqVWXYgdt7qQT9m-dtWBSTKP06DCuL-QHfmU_rvCLJ8i3-ORGmSlXiAYD20LLenpUoFrUnLdsDR1OD9pLNdPG8PF24XABs-KN8XKJQt002iwrxvx5v0Xkl8iPsSuA9qYBDOjzw7rkCi-4Zdde5zu7C4_0ebg5ArUBdvQY_d-o0-a5n8WXQtOlk2GVZAt0aDeGaoc3Cjs2uaL2VbuLlQvHJK3FNg0rMxqtNdtNTgcnpCCBmMYB6dIoas0-k10C0lbncIhbjYZj59DbCWLVZJZ5HunG9zUwIv9srRpZzwoxbAOwEDcdMuSq-vhVVO5Yv23wv8Vb9FpIEjgR4MmfIZ96Ji1QBaHy9FNAvD_Nq3GdDjjzp4Z_wV_uPLec2oKwsio1ZJ8LGB07mvxifASgx7276ZgJcG6NQFtB5os598HZBOE_ClzuzwKD8repwJGSsrtL33teJUkPVlnZJyzZAzLeZzkNoztAN9ye24YQo_GXWBWwRAVjFG-DnzjjL8ChvOo5DbWaD3dnUL2Iz5I8XZhFj-oKr4-8X1XGJXTkiNQ4HnWJcJ0VG2hVIoWs45KL3oX5i8wbBS7wj5BzzlyucZ8t9ERMV-hzZ9ZoycU0-_ur_KPWET8BJp8MvDb1Uukz7cfKPxMNkj0vUR6lqc&state=toto
```

--------------------------------

### Install DigitalPersona Kiosk with Feature Exclusion

Source: https://docs.hidglobal.com/digitalpersona-v4.4.0/ad/deploy/install-kiosk.htm

Example command to install all default features while explicitly excluding the Password Manager component.

```bash
msiexec /i setup.msi ADDLOCAL=ALL REMOVE=PasswordMgr
```

--------------------------------

### Device Import PSKC Examples

Source: https://docs.hidglobal.com/dev/scim/v4/ActivID-OpenAPI-SCIM-4.0.yaml

Examples for importing PSKC devices using synchronous and asynchronous modes.

```json
value:
  adapter: OATH-PSKC
  mapping:
    - deviceType: DT_FXT_OE
      algo: HOTP
    - deviceType: DT_FXT_OT
      algo: TOTP
  encryptionKey: 1.1111111222222224e+31
  resyncWindow: 20
  status: ACTIVE
  payload: '<binary file content - base64 encoded>'
  async: false
```

```json
value:
  adapter: OATH-PSKC
  mapping:
    - deviceType: DT_FXT_OE
      algo: HOTP
    - deviceType: DT_FXT_OA
      algo: OCRA
  encryptionKey: 1.1111111222222224e+31
  resyncWindow: 20
  status: ACTIVE
  payload: '<binary file content - base64 encoded>'
  async: true
  correlationId: 1SFCBFBFVCGTCV7QVTBV
  startDate: '2021-12-03T16:45:20.153Z'
  endDate: '2021-12-03T16:45:20.153Z'
```

--------------------------------

### Authenticator Policy GET Responses

Source: https://docs.hidglobal.com/dev/scim/v9/ActivID-OpenAPI-SCIM-9.0.0.yaml

Examples of GET response payloads for retrieving Password, Credential, and Security Question authenticator policies.

```yaml
AuthenticatorPolicyPassword_GET_V6:
  value:
    schemas:
      - urn:hid:scim:api:idp:2.0:policy:Authenticator
      - urn:hid:scim:api:idp:2.0:policy:authenticator:Password
    meta:
      resourceType: AuthenticatorPolicy
      location: https://server.example.com:8445/configuration/tenantexample/v2/Policy/Authenticator/AT_XXX
      version: '1'
    readOnly: false
    id: AT_YYY
    name: AT new name
    notes: AT new notes
    defaultValidDaysAdd: 1825
    defaultValidDaysEdit: 1825
    disableThreshold: 5
    defaultExpiryThreshold: -1
    sessionTimeout: 300000
    sessionValidPeriod: 3600000
    levelOfAssurance: '1'
    disabledTimeReset: 900
    urn:hid:scim:api:idp:2.0:policy:authenticator:Password:
      allowExpiredReset: 1
      passwordPolicy:
        characterRange: NUM_AND_ALPHA
        minLength: 8
        maxLength: 100
        minDiffChars: 5
        atLeastOneNum: true
        atLeastOneLow: true
        atLeastOneUp: true
        atLeastOneSpecial: true
        notBlackListed: true
        notSequence: true
        notOldPassword: true
        notUserAttribute: true
        caseInsensitive: false
      usernamePolicy:
        characterRange: NUM_AND_ALPHA
        minLength: 8
        maxLength: 100
        minDiffChars: 5
```

```yaml
AuthenticatorPolicyCredential_GET_V6:
  value:
    schemas:
      - urn:hid:scim:api:idp:2.0:policy:Authenticator
      - urn:hid:scim:api:idp:2.0:policy:authenticator:Credential
    meta:
      resourceType: AuthenticatorPolicy
      location: https://server.example.com:8445/configuration/tenantexample/v2/Policy/Authenticator/AT_ADSOTP
      version: '1'
    readOnly: false
    id: AT_ADSOTP
    name: ADFS Seos One Time Password
    notes: Seos One time password for ADFS users
    defaultValidDaysAdd: 18250
    defaultValidDaysEdit: 1
    disableThreshold: 10
    defaultExpiryThreshold: -1
    sessionTimeout: 3600000
    sessionValidPeriod: 86400000
    levelOfAssurance: '1'
    deliveryGateways:
      - display: Test
        value: 11154
    urn:hid:scim:api:idp:2.0:policy:authenticator:Credential:
      validCredentialPolicies:
        - CT_SEOS_OTP
      challengeType: UD
      disableThreshold: '10'
```

```yaml
AuthenticatorPolicySQ_GET_V6:
  value:
    schemas:
      - urn:hid:scim:api:idp:2.0:policy:Authenticator
      - urn:hid:scim:api:idp:2.0:policy:authenticator:SecurityQuestion
    meta:
      resourceType: AuthenticatorPolicy
      location: https://server.example.com:8445/configuration/tenantexample/v2/Policy/Authenticator/AT_CUSTQA
      version: '1'
    readOnly: false
    id: AT_CUSTQA
    name: Customer Emergency Questions & Answers
    notes: Emergency Q&A for customer authentication
    defaultValidDaysAdd: 1825
    defaultValidDaysEdit: 1825
    disableThreshold: 8
    defaultExpiryThreshold: 0
    sessionTimeout: 3600000
    sessionValidPeriod: 86400000
    levelOfAssurance: '1'
    deliveryGateways:
      - display: Test
        value: 11154
    urn:hid:scim:api:idp:2.0:policy:authenticator:SecurityQuestion:
      prompts:
        - prompt:
            display: Childhood nickname
            value: PR_NICK
          policy:
            minLength: "4"
            maxLength: "20"
            onlyNum: "false"
            onlyAlpha: "false"
            numOrAlpha: "false"
            numAndAlpha: "false"
            caseInsensitive: "true"
            notUserAttribute: "false"
```

--------------------------------

### Run the Validation Responder installer

Source: https://docs.hidglobal.com/validation-responder-v7.5/docs/install-config/install-vr-linux.htm

Execute the binary file from the terminal to initiate the installation process.

```bash
[xxx@localhost ~]$ ./ValidationResponder-7.5.bin
```

--------------------------------

### Authenticator GET Response

Source: https://docs.hidglobal.com/dev/scim/v11/ActivID-OpenAPI-SCIM-11.2.0.yaml

Example response for an authenticator retrieval operation.

```json
location: https://server.example.com:8445/scim/tenantexample/v2/Authenticator/11288.AT_CUSTOTP
          version: 1
        status:
          status: ENABLED
          active: true
          startDate: 2015-05-15T18:15:21+00:00
          expiryDate: 2018-05-15T18:15:21+00:00
        owner:
          type: User
          display: user12345
          value: 12345
          location: https://server.example.com:8445/scim/tenantexample/v2/Users/12345
        statistics:
          consecutiveFailed: 0
          consecutiveSuccess: 0
          maximumNumberOfUsages: 0
          totalFailed: 0
          totalSuccess: 0
        policy:
          display: AT_CUSTOTP
          value: AT_CUSTOTP
          location: https://server.example.com:8445/scim/tenantexample/v2/Policy/Authenticator/AT_CUSTOTP
```
Tokens:
Raw