User Mobile Access (Fudo Officer)

Get the User Mobile Access Status

This endpoint returns information about the availability of mobile access for the specified user.

Attribute	Description
is_supported	true if mobile access is supported, which requires the Call Home feature to be enabled.
can_bind	true if mobile access is supported, the specified user is the caller, and the caller can modify their own user or a pairing has been initiated for them.
can_initiate	true if mobile access is supported, the caller has the modify right on the user, and the user has no Fudo Officer authentication method yet.
can_unbind	true if the specified user is the caller, or the caller has the modify or delete right on the user.

Request

Method	GET
Path	/api/v2/user/<user_id>/mobile/access
Headers	Content-Type: Application/json

GET /api/v2/user/<user_id>/mobile/access

Example Request

curl -s -k -X GET \
  -H 'Authorization: <token>' \
  'https://10.33.4.94/api/v2/user/5890708312600608770/mobile/access'

Response

{
    "result": "success",
    "mobile_access": {
        "is_supported": true,
        "can_bind": false,
        "can_initiate": true,
        "can_unbind": true
    }
}

Initiate User Mobile Access Pairing

This endpoint lets an administrator initiate pairing of the Fudo Officer mobile application for the specified user. The user then completes the pairing in the User Access Gateway (see Profile Authentication Methods Management). The request requires the modify right on the user and fails if the user already has a Fudo Officer authentication method.

Request

Method	POST
Path	/api/v2/user/<user_id>/mobile/access

POST /api/v2/user/<user_id>/mobile/access

The request body must be an empty JSON object. The response contains the user_authentication_method object with the identifier of the created authentication method (id), and the user’s user_id and user_name. If the user already has a Fudo Officer authentication method, the request fails with the message Mobile application access already initialized.

Example Request

curl -s -k -X POST \
  -H 'Authorization: <token>' \
  -H 'Content-Type: application/json' \
  -d '{}' \
  'https://10.33.4.94/api/v2/user/5890708312600608770/mobile/access'

Response

{
    "result": "success",
    "user_authentication_method": {
        "user_id": 5890708312600608770,
        "user_name": "john_smith",
        "id": "5890708312600608772"
    }
}

Delete User Mobile Access Binding

This endpoint removes (unbinds) the mobile access binding for the specified user.

Request

Method	DELETE
Path	/api/v2/user/<user_id>/mobile/access
Headers	Content-Type: Application/json

DELETE /api/v2/user/<user_id>/mobile/access

Example Request

curl -s -k -X DELETE \
  -H 'Authorization: <token>' \
  'https://10.33.4.94/api/v2/user/5890708312600608770/mobile/access'

Response

{
    "result": "success"
}