Skip to main content
POST
/
acs
/
encoders
/
scan_to_assign_credential
{
  "action_attempt": {
    "action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action_type": "SCAN_TO_ASSIGN_CREDENTIAL",
    "result": {},
    "error": {
      "type": "<string>",
      "message": "<string>"
    }
  },
  "ok": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
acs_encoder_id
string<uuid>
required

ID of the acs_encoder to use to scan the credential.

​
acs_user_id
string<uuid>

ID of the acs_user to assign the scanned credential to.

​
salto_ks_metadata
object

Salto KS-specific metadata for the scan action.

​
user_identity_id
string<uuid>

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.

Response

OK

​
action_attempt
object
required

Tracks the progress of this operation. Poll using the action_attempt_id.

​
ok
boolean
required