@seamapi/http - v2.4.1
    Preparing search index...

    Type Alias AcsEncodersScanToAssignCredentialParameters

    Parameters for SeamHttpAcsEncoders.scanToAssignCredential.

    type AcsEncodersScanToAssignCredentialParameters = {
        acs_encoder_id: string;
        acs_user_id?: string;
        salto_ks_metadata?: { detect_new_tags?: boolean };
        user_identity_id?: string;
    }
    Index
    acs_encoder_id acs_user_id? salto_ks_metadata? user_identity_id?
    acs_encoder_id: string

    ID of the acs_encoder to use to scan the credential.

    acs_user_id?: string

    ID of the acs_user to assign the scanned credential to.

    salto_ks_metadata?: { detect_new_tags?: boolean }

    Salto KS-specific metadata for the scan action.

    Type Declaration

    • Optionaldetect_new_tags?: boolean

      When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.

    user_identity_id?: string

    ID of the user_identity to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.

    Settings
    Member Visibility

    On This Page
    Properties