F5 Beacon API

Postman collection and API reference

Authenticate against F5 Cloud Service API

To send an API request to any F5 Cloud Service API, a bearer token must be obtained, see API overviews and example for additional detail.

Specify preferred account header in a multiple accounts/divisions scenario

A user can be associated with multiple accounts or have configured divisions. In these scenarios, to disambiguate the account information, a header named X-F5aaS-Preferred-Account-Id needs to be added with the account ID value.

Account membership information is available via the following APIs.

Retrieve the user ID and primary account ID via:

GET https://api.cloudservices.f5.com/v1/svc-account/user
{
    "id": "u-aaPgo44WXX",
    "email": "user@f5.com",
    "first_name": "John",
    "last_name": "Smith",
    "phone": "+1 (555) 111-1111",
    "primary_account_id": "a-aaT6XYZa9j",
    ...

Retrieve account memberships via:

GET https://api.cloudservices.f5.com/v1/svc-account/users/<USER_ID>/memberships
{
    "memberships": [
        {
            "account_id": "a-aaSXXdAYYY2",
            "account_name": "NW - Zone",
            "role_name": "privileged-user",
            ...

        },
        {
            "account_id": "a-aahXYZLa7H",
            "account_name": "f5",
            "role_name": "privileged-user",
            ...
        },
        {
            "account_id": "a-ahhhZMXXJU",
            "account_name": "HR",
            "role_name": "owner",
            ...
        },
        {
            "account_id": "a-aaT6XYZa9j",
            "account_name": "F5 Networks",
            "role_name": "owner",
            ...
        }
    ]
}

Note

It is recommended to always set the preferred account header to make any future transition to a multiple accounts/divisions scenario easier.