Create a Machine Authenticator

POST 
/api/web/v1/users/:userid/machines

Create a Machine Authenticator for a user. Caller requires the USERMACHINES:ADD permission.

Request

Path Parameters

userid stringrequired

The UUID of the user for which the machine authenticator is to be added.

application/json

Body

required

fingerprint string

The device fingerprint. It must be a valid fingerprint as produced by Entrust SDK.

label stringrequired

Identifies the device/machine from the end-user point of view.

Responses

200

Successful

application/json

Schema

Schema

machineAuthenticator

object

Machine authenticator required to complete authentication challenge

fingerprint string

The device fingerprint if it's required during Machine authentication. It will always be null when returned from IDaaS as part of the response body.

machineNonce string

machineNonce

sequenceNonce string

sequenceNonce

userMachineAuthenticator

object

UserMachineAuthenticator

expiryTime date-time

When this machine secret expires in UTC time

id stringrequired

Identifies the device/machine

label stringrequired

Identifies the device/machine from the end-user point of view

lastUsedTime date-time

When this machine secret was last used

registrationTime date-timerequired

When this machine secret was created in UTC time

Example (from schema)

{
  "machineAuthenticator": {
    "fingerprint": "platform:web,version:1.0.2.",
    "machineNonce": "07ZeToA3YfoATTxoU6h2x==",
    "sequenceNonce": "03ReToA37851tyVU8f3y=="
  },
  "userMachineAuthenticator": {
    "expiryTime": "2019-02-19T13:15:27Z",
    "id": "string",
    "label": "string",
    "lastUsedTime": "2019-02-19T13:15:27Z",
    "registrationTime": "2019-02-19T13:15:27Z"
  }
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...