SeAT

SeAT Roles, Permissions and Authorization

All endpoints in this document are for version1 (/api/v1) of the SeAT API.
All methods below have the requests and responses sampled using httpie.

Available Methods

List all Roles

Type Detail
HTTP Verb GET
Endpoint /api/v1/role
Description List all recorded Roles from the database.

Sample Request:

http get http://localhost:8000/api/v1/role Accept:application/json X-Token:123456

Sample Response:

[
    {
        "id": 1,
        "title": "Superuser"
    },
    {
        "id": 2,
        "title": "Corp Accountants"
    }
]

Show Role Detail

Type Detail
HTTP Verb GET
Endpoint /api/v1/role/detail/{identifier}
Description Get details for a single SeAT Role. Shows Users with the Role, Permissions as well as Affiliations.
Parameters identifier - The identifier for the Role. Can be either the role_id or title

Sample Request:

http get http://localhost:8000/api/v1/role/2 Accept:application/json X-Token:123456

Sample Response:

{
    "affiliations": [
        {
            "affiliation": 123456,
            "id": 2,
            "pivot": {
                "affiliation_id": 2,
                "role_id": 2
            },
            "type": "corp"
        }
    ],
    "id": 2,
    "permissions": [
        {
            "id": 2,
            "pivot": {
                "permission_id": 2,
                "role_id": 2
            },
            "title": "corporation.wallet_journal"
        }
    ],
    "title": "Corp Accountants",
    "users": [
        {
            "active": 0,
            "created_at": "2015-11-21 14:12:07",
            "email": "admin@seat.local",
            "id": 1,
            "last_login": "2015-11-30 03:55:44",
            "last_login_source": "::1",
            "name": "admin",
            "pivot": {
                "role_id": 2,
                "user_id": 1
            },
            "updated_at": "2015-11-30 03:55:44"
        },
        {
            "active": 0,
            "created_at": "2015-11-26 18:58:29",
            "email": "test@test.com",
            "id": 2,
            "last_login": "2015-11-26 18:58:29",
            "last_login_source": "::1",
            "name": "test",
            "pivot": {
                "role_id": 2,
                "user_id": 2
            },
            "updated_at": "2015-11-26 21:11:12"
        }
    ]
}

List all Permissions

Type Detail
HTTP Verb GET
Endpoint /api/v1/role/query/permissions
Description List all of the possible SeAT Permissions.

Sample Request:

http get http://localhost:8000/api/v1/role/query/permissions Accept:application/json X-Token:123456

Sample Response:

{
    "0": "superuser",
    "1": "queue_manager",
    "apikey": [
        "delete",
        "detail",
        "toggle_status",
        "list",
        "update"
    ],
    "character": [
        "assets",
        "calendar",
        "contacts",
        "contracts",
        "industry",
        "killmails",
        "list",
        "mail",
        "market_orders",
        "notifications",
        "pi",
        "research_agents",
        "skills",
        "standings",
        "sheet",
        "wallet_journal",
        "wallet_transactions"
    ]
}

Create New Role

Type Detail
HTTP Verb POST
Endpoint /api/v1/role/new
Description Create a new SeAT role.
Parameters name - The name for the new Role.

Sample Request:

http post http://localhost:8000/api/v1/role/new name=api_test Accept:application/json X-Token:123456

Sample Response:

true

Delete Role

Type Detail
HTTP Verb DELETE
Endpoint /api/v1/role/remove/{role_id}
Description Delete a SeAT role.
Parameters role_id - The id for the Role to delete.

Sample Request:

http delete http://localhost:8000/api/v1/role/remove/3 Accept:application/json X-Token:123456

Sample Response:

true

Affiliate Character with a Role

Type Detail
HTTP Verb POST
Endpoint /api/v1/role/affiliation/character
Description Affiliate a character with a role.
Parameters role_id - The id for the Role.
character_id - The id from the Character.
inverse (optional) - true if the affiliation should be reversed.

Sample Request:

http get http://localhost:8000/api/v1/role/affiliation/character \
    role_id=2 character_id=648798798\
    Accept:application/json X-Token:123456

Sample Response:

true

Affiliate Corporation with a Role

Type Detail
HTTP Verb POST
Endpoint /api/v1/role/affiliation/corporation
Description Affiliate a corporation with a role.
Parameters role_id - The id for the Role.
corporation_id - The id from the Corporation.
inverse (optional) - true if the affiliation should be reversed.

Sample Request:

http get http://localhost:8000/api/v1/role/affiliation/corporation \
    role_id=2 corporation_id=648798798\
    Accept:application/json X-Token:123456

Sample Response:

true

Grant User a Role

Type Detail
HTTP Verb GET
Endpoint /api/v1/role/grant-user-role/{user_id}/{role_id}
Description Grant a SeAT user a SeAT role.
Parameters user_id - The id for the User.
role_id - The id for the Role.

Sample Request:

http get http://localhost:8000/api/v1/role/grant-user-role/2/2 \
    Accept:application/json X-Token:123456

Sample Response:

true

Revoke User from Role

Type Detail
HTTP Verb GET
Endpoint /api/v1/role/revoke-user-role/{user_id}/{role_id}
Description Remove a SeAT user from a SeAT role.
Parameters user_id - The id for the User.
role_id - The id for the Role.

Sample Request:

http get http://localhost:8000/api/v1/role/revoke-user-role/2/2 \
    Accept:application/json X-Token:123456

Sample Response:

true

User has Role

Type Detail
HTTP Verb GET
Endpoint /api/v1/role/query/role-check/{user_identifier}/{role_identifier}
Description Determine if a SeAT user has a specific SeAT Role.
Parameters user_identifier - The identifier for the User. Can be either the user_id or name
role_identifier - The identifier for the Role. Can be either the role_id or title

Sample Request:

// Note the quotes around the URL. If your role names have spaces in them,
// make sure you properly url encode them before adding it to the URL itself.
http get "http://localhost:8000/api/v1/role/query/role-check/admin/Corp Accountants" \
    Accept:application/json X-Token:123456

Sample Response:

true

User has Permission

Type Detail
HTTP Verb GET
Endpoint /api/v1/role/query/permission-check/{user_identifier}/{permission}
Description Determine if a SeAT user has a specific SeAT Permission. NOTE This endpoint does not honor affiliation rules!
Parameters user_identifier - The identifier for the User. Can be either the user_id or name.
permission - The identifier for the Permission. Available permissions can be found at the permissions list.

Sample Request:

http get http://localhost:8000/api/v1/role/query/permission-check/test/corporation.assets \
    Accept:application/json X-Token:123456

Sample Response:

false

Validate SeAT Credentials

Type Detail
HTTP Verb POST
Endpoint /api/v1/user/auth/login
Description Validates a SeAT accounts credentials
Parameters username - The username.
password - The password for the user.

Sample Request:

http post http://localhost:8000/api/v1/user/auth/login Accept:application/json \
    X-Token:123456 username=api_user password=blahblah

Sample Response:

true