Management API¶

The IAMPASS Management API is used to manage your IAMPASS Applications You use the Management API to:

Add users
Delete users
Registser mobile devices
Detecting if users have registered a mobile device
Handling lost devices

All calls to the IAMPASS API must include authentication data as described in API Authentication

Adding Users¶

URL:: https://main.iam-api.com/add_users/<application_id>

param

application_id: The Application ID of the application.

type

application_id: string

return

The added users in json and http status code

Example:
curl -X POST https://main.iam-api.com/management/add_users/<application_id> -H 'cache-control: no-cache' -H 'content-type: application/json' \
-d '{
    'users': ['user1', 'user2']
}'
Expected Success Response:
HTTP Status Code 201

{
    'status': True,
    'users': {
        'created': ['user1', 'user2'],
        'existing': ['existing-user1']
    }
}

HTTP Status 200

{
    'status': False,
    'reason': (string)
}
Expected Fail Response:
HTTP Status Code 404

Client Application <application_id> not found
Authentication

HMAC using Application ID and Application Secret

Deleting Users¶

URL:: https://main.iam-api.com/delete_users/<application_id>

param

application_id: The Application ID of the application.

type

application_id: string

return

Operation result as json and HTTP status code

Example:
curl -X POST https://main.iam-api.com/management/delete_users/<application_id> -H 'cache-control: no-cache' -H 'content-type: application/json' \
-d '{
    'users': ['user1', 'user2']
}'
Expected Success Response:
HTTP Status Code 200

{
    'status': True,
}
Expected Fail Response:

HTTP Status Code 404

Client Application <application_id> not found

Authentication

HMAC using Application ID and Application Secret

Device Registration¶

This endpoint will obtain a device registration link that can be shared with users.

See Getting Started for information about registration links.

URL:: https://main.iam-api.com/device_registration_link/application_id/user_id?display_name=display_name

param

application_id: The Application ID of the application.

type

application_id: string

param

user_id: The ID of the user. This value must be URL encoded.

type

user_id: string

param

display_name: (Optional) string that will be used by the IAMPASS Mobile App to display the user information. You can use something like ‘user1@my_application’. This value must be URL encoded.

return

Operation result as json and HTTP status code

Example:
curl -X GET https://main.iam-api.com/management/device_registration_link/<application_id>/<userID>?display_name="user1" -H 'cache-control: no-cache' -H 'content-type: application/json'
Expected Success Response:
HTTP Status Code 200

{
    'register_url': (string)
    'status': True,
}
Expected Fail Response:

HTTP Status Code 404

Client Application application_id or User user_id not found.

Authentication

HMAC using Application ID and Application Secret

Checking for Registered Device¶

URL:: https://main.iam-api.com/has_registered_mobile_device/application_id/user_id

param

application_id: The Application ID of the application.

type

application_id: string

param

user_id: The ID of the user. This value must be URL encoded.

type

user_id: string

return

Operation result as json and HTTP status code

Example:
curl -X GET https://main.iam-api.com/management/has_registered_mobile_device/<application_id>/<userID> -H 'cache-control: no-cache' -H 'content-type: application/json'
Expected Success Response:
HTTP Status Code 200

{
    'device_registered': True/False
    'status': True,
}
Expected Fail Response:

HTTP Status Code 404

Client Application application_id or User user_id not found.

Authentication

HMAC using Application ID and Application Secret

Dealing with Lost Devices¶

This endpoint will disable a user’s mobile device and generate a new registration link.

See Getting Started for information about registration links.

URL:: https://main.iam-api.com/lost_user_mobile_device/application_id/user_id

param

application_id: The Application ID of the application.

type

application_id: string

param

user_id: The ID of the user. This value must be URL encoded.

type

user_id: string

return

Operation result as json and HTTP status code

Example:
curl -X GET https://main.iam-api.com/management/lost_user_mobile_device/<application_id>/<userID> -H 'cache-control: no-cache' -H 'content-type: application/json'
Expected Success Response:
HTTP Status Code 200

{
    'register_url': (string)
    'status': True,
}
Expected Fail Response:

HTTP Status Code 404

Client Application application_id or User user_id not found.

Authentication

HMAC using Application ID and Application Secret