{
  "opencollection": "1.0.0",
  "info": {
    "name": "Gremlin agents users API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all active users.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/users/active",
            "params": [
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "Requires the privilege [`USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Get all active users paginated.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/users/active/paged",
            "params": [
              {
                "name": "pageSize",
                "value": "None (unlimited)",
                "type": "query",
                "description": "This value determines how many results will be returned per call."
              },
              {
                "name": "pageToken",
                "value": "None (returns first page)",
                "type": "query",
                "description": "Token corresponding to the last page of active company users for team retrieved. Pass the pageToken to get the next page of active company users for team"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "Requires the privilege [`USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Get all users.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/users",
            "params": [
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "Requires the privilege [`USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Add an existing user to the target team",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/users",
            "params": [
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User must belong to this teams company\nRequires the privilege [`USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Get all users paginated.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/users/paged",
            "params": [
              {
                "name": "pageSize",
                "value": "None (unlimited)",
                "type": "query",
                "description": "This value determines how many results will be returned per call."
              },
              {
                "name": "pageToken",
                "value": "None (returns first page)",
                "type": "query",
                "description": "Token corresponding to the last page of company users for team retrieved. Pass the pageToken to get the next page of company users for team"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "Requires the privilege [`USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Get information about the authenticated user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/users/self"
          },
          "docs": "Requires the privilege [`MINIMUM_COMPANY_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Update an existing users info.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.gremlin.com/v1/users/self",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User must exist.\nRequires the privilege [`MINIMUM_COMPANY_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Invite a user.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/users/invite",
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "email",
                  "value": ""
                },
                {
                  "name": "source_detail",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Requires the privilege [`COMPANY_USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Renew authorization.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/users/renew/rbac",
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "email",
                  "value": ""
                },
                {
                  "name": "companyId",
                  "value": ""
                },
                {
                  "name": "teamId",
                  "value": ""
                },
                {
                  "name": "renewToken",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Renew authorization."
        },
        {
          "info": {
            "name": "Update an existing user.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.gremlin.com/v1/users/:email",
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "role",
                  "value": ""
                }
              ]
            }
          },
          "docs": "User must exist.\nRequires the privilege [`USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Deactivate a user.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.gremlin.com/v1/users/:email",
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "Required when using company session token."
              }
            ]
          },
          "docs": "Requires the privilege [`USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns the updated user sessions list for the currently authenticated user.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/users/sessions",
            "params": [
              {
                "name": "getCompanySession",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Requires the privilege [`MINIMUM_COMPANY_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Revoke a pending user invite.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.gremlin.com/v1/users/invite/:email",
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANY_USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        }
      ]
    }
  ],
  "bundled": true
}