API by router
Pin confirmation
GET
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
PIN status response.
created_at?|nullhas_pin*Has Pinis_active?Is ActiveDefault
falseis_locked?Is LockedDefault
falselocked_until?|nullcurl -X GET 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin'Example Response
{ "created_at": "2019-08-24T14:15:22Z", "has_pin": true, "is_active": false, "is_locked": false, "locked_until": "2019-08-24T14:15:22Z"}POST
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidX-Api-Key?string|nullapplication/json- body
Set or change a PIN. Digits only, 4-8 characters.
pin*PinSuccessful Response
application/json- response
PIN status response.
created_at?|nullhas_pin*Has Pinis_active?Is ActiveDefault
falseis_locked?Is LockedDefault
falselocked_until?|nullcurl -X POST 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin' \ -H 'Content-Type: application/json' \ -d '{ "pin": "string"}'Example Response
{ "created_at": "2019-08-24T14:15:22Z", "has_pin": true, "is_active": false, "is_locked": false, "locked_until": "2019-08-24T14:15:22Z"}DELETE
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin'Example Response
Empty
GET
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
Current PIN policy for an instance.
instance_id*Instance Idpin_applies_to?Pin Applies ToDefault
"all"pin_required_skills?array<string>Default
[]pin_session_ttl_minutes?Pin Session Ttl MinutesDefault
30curl -X GET 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin-policy'Example Response
{ "instance_id": "string", "pin_applies_to": "all", "pin_required_skills": [], "pin_session_ttl_minutes": 30}PATCH
HTTPBearerheader
AuthorizationBearer <token>instance_id*Instance IdFormat
uuidX-Api-Key?string|nullapplication/json- body
Configure which skills require PIN confirmation on an instance.
pin_applies_to?string|nullpin_required_skills?array<string>|nullpin_session_ttl_minutes?integer|nullSuccessful Response
application/json- response
Current PIN policy for an instance.
instance_id*Instance Idpin_applies_to?Pin Applies ToDefault
"all"pin_required_skills?array<string>Default
[]pin_session_ttl_minutes?Pin Session Ttl MinutesDefault
30curl -X PATCH 'https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin-policy' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "instance_id": "string", "pin_applies_to": "all", "pin_required_skills": [], "pin_session_ttl_minutes": 30}GET
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
PIN status response.
created_at?|nullhas_pin*Has Pinis_active?Is ActiveDefault
falseis_locked?Is LockedDefault
falselocked_until?|nullcurl -X GET 'https://example.com/v1/me/pin'Example Response
{ "created_at": "2019-08-24T14:15:22Z", "has_pin": true, "is_active": false, "is_locked": false, "locked_until": "2019-08-24T14:15:22Z"}