{"info":{"_postman_id":"664284e4-6e74-52d5-bad5-01233ce1704c","name":"Charcoal API","description":"

This project serves as the JSON/REST API consumed by clients of the Charcoal platform.

The api itself relies heavily on user-client authentication where every request needs to have the appropriate information to attribute it to a client, and requests acting on behalf of a user (e.g updating their email) needs to have a user-client token created by the user to authorize that client to communicate for them.

Some endpoints are completely restricted to \"admin only\" which means only users mapped to the admin role who are communicating with a \"system\" client may continue.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1070956","collectionId":"664284e4-6e74-52d5-bad5-01233ce1704c","publishedId":"6YsXcyj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2017-02-25T01:07:44.000Z"},"item":[{"name":"Authentication","item":[{"name":"Current User","id":"2d3a6d7a-e22a-914e-f99f-5af1050c5120","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"","description":"

Once a user has authorized a client to communicate on their behalf (via the auth/authorize endpoint), the client can use the generated token in their x-client-bearer-token header to retreive the user's information from this endpoint.

\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"2d3a6d7a-e22a-914e-f99f-5af1050c5120"},{"name":"Available Tokens","id":"518e639c-7da1-e67c-81c8-712d7577b2c5","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/auth/tokens","description":"

In order for a given client to retreive a list of tokens that users have created for the client to communicate with, they can send a request (with the x-client-auth header set appropriately) to this endpoint.

\n","urlObject":{"protocol":"http","path":["auth","tokens"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"518e639c-7da1-e67c-81c8-712d7577b2c5"},{"name":"Current Roles","id":"1a4f2221-39df-e757-124a-c3679b3ee943","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/auth/roles","urlObject":{"protocol":"http","path":["auth","roles"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1a4f2221-39df-e757-124a-c3679b3ee943"},{"name":"Google Prompt","id":"111be9b1-8354-260a-2e9a-cd58d636c4d7","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/oauth/google/prompt?client_id=2424a8f3adef42072cc6","description":"

This endpoint should be used by clients looking to authenticate users with the CAAP api through google.

The route requires a client_id query parameter and will redirect the user to the google oauth flow. Once the user has authenticated with google, caap will handle creating the user record and will redirect the user to the redirect_uri associated with the client who initiated the request.

The redirect_uri will receive token query parameter, which the client should use to then communicate with the api.

\n","urlObject":{"protocol":"http","path":["oauth","google","prompt"],"host":["{{hostname}}"],"query":[{"key":"client_id","value":"2424a8f3adef42072cc6"}],"variable":[]}},"response":[],"_postman_id":"111be9b1-8354-260a-2e9a-cd58d636c4d7"},{"name":"Google Callback","id":"3aa4b518-23a8-7a73-35d0-79b8a471d2e8","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/oauth/google/auth","description":"

This endpoint should never be accessed directly by clients, it is only ever used during the google oauth process during oauth.

\n","urlObject":{"protocol":"http","path":["oauth","google","auth"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3aa4b518-23a8-7a73-35d0-79b8a471d2e8"},{"name":"Password Login (System Clients Only)","id":"30389028-5df5-817f-77c9-737e02a73fe9","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"dadleyy@gmail.com\",\n\t\"password\": \"password\"\n}"},"url":"http://{{hostname}}/auth","description":"

\n","urlObject":{"protocol":"http","path":["auth"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"30389028-5df5-817f-77c9-737e02a73fe9"}],"id":"3414ce4e-06be-b0a4-6d87-ad6e01ec9064","description":"

The majority of requests made against the api require the client to provide a x-client-auth header, who's value is the base64 encoded string composed of their client id and secret separated by a colon. Beyond that, users are able to authorize clients to communicate on their behalf by creating \"client tokens\". In order for the user to communicate with the api, the client must send these tokens along in a x-client-bearer-token header to the api.

The endpoints under this group allow clients to access information relevant to them. This includes:

User tokens created for that client (x-client-auth only)
\n
User information given a bearer token (x-client-bearer required)
\n
The roles associated with a user (x-client-bearer required)
\n

\n","_postman_id":"3414ce4e-06be-b0a4-6d87-ad6e01ec9064"},{"name":"Client Management","item":[{"name":"GET client admins","id":"d1e3ad3a-1720-60b9-9738-2db99fc554c4","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/client-admins","description":"

This endpoint is used to access the user-client mappings that represent a user's ability to edit client information.

Unless the user is a system admin, this list will be filtered by the current client in order to prevent clients from accessing other client's information.

\n","urlObject":{"protocol":"http","path":["client-admins"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1e3ad3a-1720-60b9-9738-2db99fc554c4"},{"name":"POST client admin","id":"4f01ad16-5108-c70d-547c-50f19486a7b7","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"user","value":"3","type":"text"},{"key":"client","value":"3","type":"text"}]},"url":"http://{{hostname}}/client-admins","description":"

Allows users to add another user to the client's list of admins. It is assumed that when posting to this route that the current client (based on x-client-auth) is the client of which the user is adding a client admin.

(unless the user is a system admin)

\n","urlObject":{"protocol":"http","path":["client-admins"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f01ad16-5108-c70d-547c-50f19486a7b7"},{"name":"DELETE client admin","id":"5ebf07ed-e9f7-b911-2336-773e2c2c424f","request":{"method":"DELETE","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"user","value":"3","type":"text"},{"key":"","value":"","type":"text"}]},"url":"http://{{hostname}}/client-admins/5","description":"

Allows users to delete a mapping from user to client that represents the user being a client admin.

\n","urlObject":{"protocol":"http","path":["client-admins","5"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ebf07ed-e9f7-b911-2336-773e2c2c424f"},{"name":"GET clients","id":"cc9fb00a-15a4-67c1-b981-e4356b688339","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/clients","urlObject":{"protocol":"http","path":["clients"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc9fb00a-15a4-67c1-b981-e4356b688339"},{"name":"POST client","id":"fd5e388c-1c0c-232a-d7de-0f8386f2352e","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"client number 2","type":"text"},{"key":"description","value":"this is a testing client","type":"text"},{"key":"redirect_uri","value":"http://google.com","type":"text"}]},"url":"http://{{hostname}}/clients","urlObject":{"protocol":"http","path":["clients"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd5e388c-1c0c-232a-d7de-0f8386f2352e"},{"name":"UPDATE client","id":"221d39bc-5547-7afd-c44c-45aa87b4a52c","request":{"method":"PATCH","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/clients/2","urlObject":{"protocol":"http","path":["clients","2"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"221d39bc-5547-7afd-c44c-45aa87b4a52c"},{"name":"GET client tokens (admin only)","id":"6856103a-bd0a-45c4-d566-93d9e12d95ee","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/client-tokens","urlObject":{"protocol":"http","path":["client-tokens"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6856103a-bd0a-45c4-d566-93d9e12d95ee"},{"name":"POST client token (admin only)","id":"61e74dea-e3d5-1c3a-610d-1689e9d54fef","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"client","value":"3","type":"text"}]},"url":"http://{{hostname}}/client-tokens","urlObject":{"protocol":"http","path":["client-tokens"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"61e74dea-e3d5-1c3a-610d-1689e9d54fef"}],"id":"cd2af49f-967e-1afc-8e73-7735e3dac18d","description":"

Unlike other routes, the client management endpoints - which are responsible for CRUD operations on all things clients - are restricted both by the current client AND the current user.

\n","_postman_id":"cd2af49f-967e-1afc-8e73-7735e3dac18d"},{"name":"Game Management","item":[{"name":"Find Games","id":"5ceebdf6-7d76-e4b9-5546-ae0ea2ded899","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/games","urlObject":{"protocol":"http","path":["games"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ceebdf6-7d76-e4b9-5546-ae0ea2ded899"},{"name":"Update Game","id":"229261e8-eee6-3646-2ae0-341f255ce076","request":{"method":"PATCH","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"name\": \"foo\" }"},"url":"http://{{hostname}}/games/2","urlObject":{"protocol":"http","path":["games","2"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"229261e8-eee6-3646-2ae0-341f255ce076"},{"name":"End Game","id":"ce198622-6edc-f3cb-8d94-38855c053399","request":{"method":"PATCH","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \"status\": \"ENDED\" }"},"url":"http://{{hostname}}/games/2","urlObject":{"protocol":"http","path":["games","2"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce198622-6edc-f3cb-8d94-38855c053399"},{"name":"Create Game","id":"81fcd0a0-fbf2-09c9-0a16-3664a9a98944","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ }"},"url":"http://{{hostname}}/games","urlObject":{"protocol":"http","path":["games"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"81fcd0a0-fbf2-09c9-0a16-3664a9a98944"},{"name":"Delete Game","id":"66ae9b58-e190-94d6-9bfc-d323a2404e0e","request":{"method":"DELETE","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/games/3","urlObject":{"protocol":"http","path":["games","3"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"66ae9b58-e190-94d6-9bfc-d323a2404e0e"},{"name":"Find Game Rounds","id":"4950caec-a12d-66e8-21c1-ec911d5ee1a8","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/game-rounds?filter[game_id]=eq(1)","urlObject":{"protocol":"http","path":["game-rounds"],"host":["{{hostname}}"],"query":[{"key":"filter[game_id]","value":"eq(1)"}],"variable":[]}},"response":[],"_postman_id":"4950caec-a12d-66e8-21c1-ec911d5ee1a8"},{"name":"Create Game Round","id":"c9edc53d-d72b-ac79-ac5d-e76e9e7a97a4","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"game_id\": \"1\"\n}"},"url":"http://{{hostname}}/game-rounds","urlObject":{"protocol":"http","path":["game-rounds"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9edc53d-d72b-ac79-ac5d-e76e9e7a97a4"},{"name":"Update Game Round","id":"965cae1b-d5db-02bc-157f-5fb40daad347","request":{"method":"PATCH","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asshole_id\": 5,\n \"president_id\": 2,\n \"vice_president_id\": 3\n}"},"url":"http://{{hostname}}/game-rounds/1","description":"

This endpoint is used to access the user-client mappings that represent a user's ability to edit client information.

Unless the user is a system admin, this list will be filtered by the current client in order to prevent clients from accessing other client's information.

\n","urlObject":{"protocol":"http","path":["game-rounds","1"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"965cae1b-d5db-02bc-157f-5fb40daad347"},{"name":"Delete game Round","id":"1ba51ef3-1b7e-1adc-1eb7-f95dc43f8ddc","request":{"method":"DELETE","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asshole_id\": \"3\",\n \"president_id\": null,\n \"vice_president_id\": null\n}"},"url":"http://{{hostname}}/game-rounds/13","description":"

This endpoint is used to access the user-client mappings that represent a user's ability to edit client information.

Unless the user is a system admin, this list will be filtered by the current client in order to prevent clients from accessing other client's information.

\n","urlObject":{"protocol":"http","path":["game-rounds","13"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ba51ef3-1b7e-1adc-1eb7-f95dc43f8ddc"},{"name":"Find Game Memberships","id":"f310f59c-eb09-3dd4-1353-df96557f699b","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/game-memberships?filter[game_id]=eq(1)","urlObject":{"protocol":"http","path":["game-memberships"],"host":["{{hostname}}"],"query":[{"key":"filter[game_id]","value":"eq(1)"}],"variable":[]}},"response":[],"_postman_id":"f310f59c-eb09-3dd4-1353-df96557f699b"},{"name":"Create Game Membership","id":"575b88c0-1f67-b414-0f4f-781c0ac16a76","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"game_id\": 3,\n \"user_id\": 2\n}"},"url":"http://{{hostname}}/game-memberships","urlObject":{"protocol":"http","path":["game-memberships"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"575b88c0-1f67-b414-0f4f-781c0ac16a76"},{"name":"Update Game Membership","id":"f6713147-8769-b676-6e4c-ae38de555f3d","request":{"method":"PATCH","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"status\": \"ACTIVE\"\n}"},"url":"http://{{hostname}}/game-memberships/4","urlObject":{"protocol":"http","path":["game-memberships","4"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6713147-8769-b676-6e4c-ae38de555f3d"},{"name":"Delete Game Membership","id":"a4f06757-ec79-1e54-6fc4-ad78640d1a7c","request":{"method":"DELETE","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/game-memberships/3","urlObject":{"protocol":"http","path":["game-memberships","3"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a4f06757-ec79-1e54-6fc4-ad78640d1a7c"},{"name":"Game Membership History","id":"401f073b-72b0-aefb-d1db-058bdc383769","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/game-membership-history","urlObject":{"protocol":"http","path":["game-membership-history"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"401f073b-72b0-aefb-d1db-058bdc383769"}],"id":"39ccbb84-977d-a539-31bb-c3b3d0dc1d61","_postman_id":"39ccbb84-977d-a539-31bb-c3b3d0dc1d61","description":""},{"name":"Mailgun Integrations","item":[{"name":"POST callbacks/mailgun (direct + images)","id":"1eb8c1cb-83b4-178b-5bc5-2b83a9719f2d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"message-url","value":"https://si.api.mailgun.net/v3/domains/mg.caap.oiq.io/messages/eyJwIjpmYWxzZSwiayI6IjhmZDZkY2YyLWZiZTgtNDc3MC1hOTA2LTcyMmFkMGZlMGYzMiIsInMiOiIwNDA2OGM2Mjc2IiwiYyI6InNhaWFkIn0=","type":"text"},{"key":"","value":"","type":"text"}]},"url":"http://{{hostname}}/callbacks/mailgun?secret={{mailgun_secret}}","urlObject":{"protocol":"http","path":["callbacks","mailgun"],"host":["{{hostname}}"],"query":[{"key":"secret","value":"{{mailgun_secret}}"}],"variable":[]}},"response":[],"_postman_id":"1eb8c1cb-83b4-178b-5bc5-2b83a9719f2d"},{"name":"POST callbacks/mailgun (direct osx)","id":"e0435e05-7b95-1fa2-1f3e-0cde694053d4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"message-url","value":"https://si.api.mailgun.net/v3/domains/mg.caap.oiq.io/messages/eyJwIjpmYWxzZSwiayI6IjA1NzVkOTExLTY0ZGUtNDlhZC05ZjgzLWYxZWJjYTEyZDMzYyIsInMiOiI5NjJkMzQ2NDliIiwiYyI6InNhaWFkIn0=","type":"text"},{"key":"","value":"","type":"text"}]},"url":"http://{{hostname}}/callbacks/mailgun?secret={{mailgun_secret}}","urlObject":{"protocol":"http","path":["callbacks","mailgun"],"host":["{{hostname}}"],"query":[{"key":"secret","value":"{{mailgun_secret}}"}],"variable":[]}},"response":[],"_postman_id":"e0435e05-7b95-1fa2-1f3e-0cde694053d4"},{"name":"POST callbacks/mailgun (ifttt)","id":"d59efd2b-3f32-1e56-c726-4e4b998aab69","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"message-url","value":"https://si.api.mailgun.net/v3/domains/mg.caap.oiq.io/messages/eyJwIjpmYWxzZSwiayI6IjQzYzg2MzA0LWViN2YtNGU2OS04MTQ0LWE1ZGZjZmNjOGRkNyIsInMiOiI3YzljNzU2YzI4IiwiYyI6InNiaWFkIn0=","type":"text"},{"key":"","value":"","type":"text"}]},"url":"http://{{hostname}}/callbacks/mailgun?secret={{mailgun_secret}}","urlObject":{"protocol":"http","path":["callbacks","mailgun"],"host":["{{hostname}}"],"query":[{"key":"secret","value":"{{mailgun_secret}}"}],"variable":[]}},"response":[],"_postman_id":"d59efd2b-3f32-1e56-c726-4e4b998aab69"},{"name":"POST callbacks/mailgun BAD","id":"05b838bc-256c-c0db-bd6d-f8bbeaf8a8f0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"message-url","value":"https://si.api.mailgun.net/v3/domains/mg.caap.oiq.io/messages/eyJwIjpmYWxzZSwiayI6IjFhMDZhZTM1LWUwNWItNDc3MS04ZjU2LWRlNTkwMDM5MTkzOCIsInMiOiJkMjY4NzBhMGM2IiwiYyI6InNiaWFkIn0=","type":"text"},{"key":"","value":"","type":"text"}]},"url":"http://{{hostname}}/callbacks/mailgun?secret={{mailgun_secret}}","urlObject":{"protocol":"http","path":["callbacks","mailgun"],"host":["{{hostname}}"],"query":[{"key":"secret","value":"{{mailgun_secret}}"}],"variable":[]}},"response":[],"_postman_id":"05b838bc-256c-c0db-bd6d-f8bbeaf8a8f0"}],"id":"394f5509-a817-dee6-f648-ecba2e8b4b4f","_postman_id":"394f5509-a817-dee6-f648-ecba2e8b4b4f","description":""},{"name":"Photo Management","item":[{"name":"GET photos","id":"ea74975d-3c04-d898-11c9-44e24c7af2af","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/photos","urlObject":{"protocol":"http","path":["photos"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea74975d-3c04-d898-11c9-44e24c7af2af"},{"name":"DELETE photos","id":"26f6e70c-aafc-8028-f15c-8abd5d930f28","request":{"method":"DELETE","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/javascript"}],"body":{"mode":"raw","raw":"[{\"id\": 1}]"},"url":"http://{{hostname}}/photos/11","urlObject":{"protocol":"http","path":["photos","11"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"26f6e70c-aafc-8028-f15c-8abd5d930f28"},{"name":"POST photos","id":"3d6bb445-bd32-d360-fa6a-83e3f51d8819","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"label","value":"dh test","type":"text"},{"key":"photo","value":null,"type":"file"}]},"url":"http://{{hostname}}/photos","urlObject":{"protocol":"http","path":["photos"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d6bb445-bd32-d360-fa6a-83e3f51d8819"},{"name":"POST photos (client-only)","id":"d1926089-db91-960a-3935-452d325133ca","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[{"key":"label","value":"something","type":"text"},{"key":"photo","value":null,"type":"file"}]},"url":"http://local.api.caap.oiq.io:8080/photos","urlObject":{"protocol":"http","port":"8080","path":["photos"],"host":["local","api","caap","oiq","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1926089-db91-960a-3935-452d325133ca"},{"name":"GET photo view","id":"ef32258c-9020-509c-bae3-fc50e470e9e1","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/photos/1/view","urlObject":{"protocol":"http","path":["photos","1","view"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef32258c-9020-509c-bae3-fc50e470e9e1"}],"id":"eacb0009-78ca-7bb3-4673-3e3427f5bced","description":"

The photos endpoints allow clients to retreive, view, create and delete photos.

this is code\n

","_postman_id":"eacb0009-78ca-7bb3-4673-3e3427f5bced"},{"name":"Sockets","item":[{"name":"http://{{hostname}}/socket","id":"ae43794f-4133-fbed-5631-bcabf61a018b","request":{"method":"GET","header":[{"key":"Upgrade","value":"WebSocket"},{"key":"Connection","value":"Upgrade"},{"key":"Sec-Websocket-Version","value":"13"},{"key":"Sec-Websocket-Key","value":"{{client_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/socket/","urlObject":{"protocol":"http","path":["socket",""],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae43794f-4133-fbed-5631-bcabf61a018b"}],"id":"047593ae-2005-ec88-3331-ab3528d7a81f","_postman_id":"047593ae-2005-ec88-3331-ab3528d7a81f","description":""},{"name":"System Diagnostics & Configuration","item":[{"name":"GET system","id":"3659cb73-eed4-b3b3-f92a-39b8d796a003","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"adsasd","value":"asdsada","type":"text"}]},"url":"http://{{hostname}}/system","urlObject":{"protocol":"http","path":["system"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3659cb73-eed4-b3b3-f92a-39b8d796a003"},{"name":"UPDATE system (admin only)","id":"3dc8891d-d490-a537-836b-7ebcfc458d6c","request":{"method":"PATCH","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"restricted_email_domains","value":"false","type":"text"}]},"url":"http://{{hostname}}/system","urlObject":{"protocol":"http","path":["system"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3dc8891d-d490-a537-836b-7ebcfc458d6c"},{"name":"GET system email domains (admin only)","id":"0372b954-614d-5f87-af2a-be1c55656e41","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"adsasd","value":"asdsada","type":"text"}]},"url":"http://{{hostname}}/system/domains","urlObject":{"protocol":"http","path":["system","domains"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0372b954-614d-5f87-af2a-be1c55656e41"},{"name":"POST system email domain (admin only)","id":"3cdf75a1-9ff4-eab6-0aae-87b61acc2dd2","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"domain","value":"owneriq.com","type":"text"}]},"url":"http://{{hostname}}/system/domains","urlObject":{"protocol":"http","path":["system","domains"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3cdf75a1-9ff4-eab6-0aae-87b61acc2dd2"},{"name":"DELETE system email domain (admin only)","id":"6aa2934b-4f14-9bb7-10af-3fdd1f1c59db","request":{"method":"DELETE","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"raw","raw":""},"url":"http://{{hostname}}/system/domains/2","urlObject":{"protocol":"http","path":["system","domains","2"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6aa2934b-4f14-9bb7-10af-3fdd1f1c59db"}],"id":"dd013c1f-2e06-f72d-d1ea-a0b5a6a0f0f8","_postman_id":"dd013c1f-2e06-f72d-d1ea-a0b5a6a0f0f8","description":""},{"name":"The Activity Feed","item":[{"name":"GET activity","id":"13fd95f4-7c5f-32e2-19c7-f387f63a86f8","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/activity?limit=1000","urlObject":{"protocol":"http","path":["activity"],"host":["{{hostname}}"],"query":[{"key":"limit","value":"1000"}],"variable":[]}},"response":[],"_postman_id":"13fd95f4-7c5f-32e2-19c7-f387f63a86f8"},{"name":"GET display-schedules","id":"b420bde7-0566-9f49-2ed4-8956c2471d06","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/display-schedules","urlObject":{"protocol":"http","path":["display-schedules"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b420bde7-0566-9f49-2ed4-8956c2471d06"},{"name":"PATCH display-schedule","id":"f32887d8-3cb2-0f02-0a0c-e2896374b8c9","request":{"method":"PATCH","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"approval\": \"APPROVED\",\n \"start\": \"2015-01-19T00:00:00Z\",\n \"end\": \"2020-01-20T00:00:00Z\"\n}"},"url":"http://{{hostname}}/display-schedules/1","urlObject":{"protocol":"http","path":["display-schedules","1"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f32887d8-3cb2-0f02-0a0c-e2896374b8c9"},{"name":"GET feed","id":"401ece7c-81e1-cfe0-39fe-f31db6a405af","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/activity/live","urlObject":{"protocol":"http","path":["activity","live"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"401ece7c-81e1-cfe0-39fe-f31db6a405af"}],"id":"74af8b11-87fa-1f6e-53da-16ee17559bff","_postman_id":"74af8b11-87fa-1f6e-53da-16ee17559bff","description":""},{"name":"User Management","item":[{"name":"GET users","id":"82f75f44-dd75-96a1-2e13-b673704b0714","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/users","urlObject":{"protocol":"http","path":["users"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"82f75f44-dd75-96a1-2e13-b673704b0714"},{"name":"PATCH users","id":"79ed0569-f25f-8982-58ff-e9d3fedcfd4b","request":{"method":"PATCH","header":[{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"beta2@charcoal.sizethree.cc\",\n\t\"password\": \"foobar1231233@#yay\"\n}"},"url":"http://{{hostname}}/users/1","urlObject":{"protocol":"http","path":["users","1"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"79ed0569-f25f-8982-58ff-e9d3fedcfd4b"},{"name":"POST users","id":"dc1b8379-d14e-eb3d-41fd-181b1c977f8c","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Mogens Alfredson\",\n \"email\": \"beta1@charcoal.sizethree.cc\",\n \"password\": \"password\",\n \"username\": \"epsilon1-user\"\n}"},"url":"http://{{hostname}}/users","urlObject":{"protocol":"http","path":["users"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc1b8379-d14e-eb3d-41fd-181b1c977f8c"},{"name":"GET user roles","id":"ffa82ca4-107b-6db3-5cc0-cbdf44de5185","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/user-roles","description":"","urlObject":{"protocol":"http","path":["user-roles"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ffa82ca4-107b-6db3-5cc0-cbdf44de5185"},{"name":"GET google-accounts","id":"f7274ed2-33ec-f323-796a-f924dad80315","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/google-accounts","urlObject":{"protocol":"http","path":["google-accounts"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7274ed2-33ec-f323-796a-f924dad80315"},{"name":"GET user-role-mappings","id":"3e428b57-9b3b-97bc-264f-3fc8b9c12580","request":{"method":"GET","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"http://{{hostname}}/user-role-mappings","urlObject":{"protocol":"http","path":["user-role-mappings"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e428b57-9b3b-97bc-264f-3fc8b9c12580"},{"name":"POST user-role-mappings (admin only)","id":"a51e3ea1-3f11-fd46-6e49-7f54cfd25432","request":{"method":"POST","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user\": 2,\n\t\"role\": 1\n}"},"url":"http://{{hostname}}/user-role-mappings","urlObject":{"protocol":"http","path":["user-role-mappings"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a51e3ea1-3f11-fd46-6e49-7f54cfd25432"},{"name":"DELETE user-role-mapping (admin only)","id":"edc98c22-71de-7839-e6f8-a84e815c268d","request":{"method":"DELETE","header":[{"key":"x-client-auth","value":"{{client_auth}}"},{"key":"x-client-bearer-token","value":"{{bearer_token}}"}],"body":{"mode":"formdata","formdata":[{"key":"user","value":"2","type":"text"},{"key":"role","value":"1","type":"text"}]},"url":"http://{{hostname}}/user-role-mappings/3","urlObject":{"protocol":"http","path":["user-role-mappings","3"],"host":["{{hostname}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"edc98c22-71de-7839-e6f8-a84e815c268d"}],"id":"ccf6e18b-e0eb-fc46-5efc-44a9d623f49d","description":"

These enpoints focus on the management of users and the system roles they are associated with.

\n","_postman_id":"ccf6e18b-e0eb-fc46-5efc-44a9d623f49d"}]}