{
  "opencollection": "1.0.0",
  "info": {
    "name": "Gremlin agents companies API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "companies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets all names of configured and detected zones",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/zones"
          },
          "docs": "Get all names of configured zone settings, and all zones detected from agents\nRequires the privilege [`TEST_SUITES_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Create a zone",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/zones",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new zone setting of the company\nRequires the privilege [`TEST_SUITES_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Allows a user to create a new Company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User must have been previously invited"
        },
        {
          "info": {
            "name": "Returns all aliases for a company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier/saml/claim-aliases",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns all aliases for a company, ordered alphabetically\nRequires the privilege [`COMPANY_SAMLCLAIM_ALIAS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Creates a claim alias for the company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/saml/claim-aliases",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a claim alias for the company. If a claim alias already exists, it will not be updated.\nRequires the privilege [`COMPANY_SAMLCLAIM_ALIAS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns all users for the supplied company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANY_USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Create a new user.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User must have been invited."
        },
        {
          "info": {
            "name": "Returns an alias for a company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier/saml/claim-aliases/:aliasId",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "aliasId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns an alias for a company, with the teams and roles ordered alphabetically\nRequires the privilege [`COMPANY_SAMLCLAIM_ALIAS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Updates a claim alias for the company",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.gremlin.com/v1/companies/:identifier/saml/claim-aliases/:aliasId",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "aliasId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a claim alias for the company, creating it if it doesn't already exist\nRequires the privilege [`COMPANY_SAMLCLAIM_ALIAS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Deletes a claim alias for the company",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.gremlin.com/v1/companies/:identifier/saml/claim-aliases/:aliasId",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "aliasId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Permanently deletes the specified alias for the company\nRequires the privilege [`COMPANY_SAMLCLAIM_ALIAS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Get a zone setting",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/zones/:zoneId",
            "params": [
              {
                "name": "zoneId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get the zone setting\nRequires the privilege [`TEST_SUITES_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Update a zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.gremlin.com/v1/companies/zones/:zoneId",
            "params": [
              {
                "name": "zoneId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a zone setting of the company\nRequires the privilege [`TEST_SUITES_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Delete zone setting",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.gremlin.com/v1/companies/zones/:zoneId",
            "params": [
              {
                "name": "zoneId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes the zone setting from the company\nRequires the privilege [`TEST_SUITES_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns paginated active users for the supplied company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users/active/paged",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "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 retrieved. Pass the pageToken to get the next page of active company users"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANY_USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns all clients for the supplied company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier/clients",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "SUPER users only\nRequires the privilege [`COMPANIES_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Gets a Company by its supplied guid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "skipTeams",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANIES_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Update the prefs for company",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.gremlin.com/v1/companies/:identifier",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint will allow you to update the prefs for a company based on its identifier.\nRequires the privilege [`COMPANY_PREFERENCES_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns paginated invited users for the supplied company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users/invited/paged",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "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 invited company users retrieved. Pass the pageToken to get the next page of invited company users"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANY_USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns paginated revoked users for the supplied company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users/revoked/paged",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "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 revoked company users retrieved. Pass the pageToken to get the next page of revoked company users"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANY_USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Returns paginated users for the supplied company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users/paged",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "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 retrieved. Pass the pageToken to get the next page of company users"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANY_USERS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Invites the specified email to create a new Company.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/invite",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Invites the specified email to create a new Company."
        },
        {
          "info": {
            "name": "Invite one or more users to join your Gremlin company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/invites",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requires the privilege [`COMPANY_USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "User must exist. This is primarily used to reactivate a deactivated user.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users/:email/active",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "email",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Activates a user.\nRequires the privilege [`COMPANY_USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Deactivates a user.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users/:email/active",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "email",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Once deactivated, user will not be able to do anything on company\nRequires the privilege [`COMPANY_USERS_WRITE`](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/companies/:identifier/invites/:email",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "email",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANY_USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Update roles of existing user.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users/:email",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "email",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User must exist.\nRequires the privilege [`COMPANY_USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Allows an invited user to create a new Company for a trial.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/trial",
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "name",
                  "value": ""
                },
                {
                  "name": "code",
                  "value": ""
                },
                {
                  "name": "adminEmail",
                  "value": ""
                },
                {
                  "name": "adminPassword",
                  "value": ""
                },
                {
                  "name": "allowUsStorage",
                  "value": ""
                }
              ]
            }
          },
          "docs": "User must have been previously invited"
        },
        {
          "info": {
            "name": "Updates the authentication preferences associated with this Company.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/auth/prefs",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requires the privilege [`COMPANY_SECURITY_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Updates the MFA preferences associated with this Company.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/mfaPrefs",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "forceMfa",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Requires the privilege [`COMPANY_SECURITY_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Updates the OAuth settings for this Company.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/oauth/settings",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Requires the privilege [`COMPANY_SECURITY_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Updates the preferences associated with this Company.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/prefs",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "domain",
                  "value": ""
                }
              ]
            }
          },
          "docs": "SUPER users only\nRequires the privilege [`COMPANY_SECURITY_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "Updates the preferences associated with this Company.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.gremlin.com/v1/companies/:identifier/saml/props",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "enabled",
                  "value": ""
                },
                {
                  "name": "entityId",
                  "value": ""
                },
                {
                  "name": "idpUrl",
                  "value": ""
                },
                {
                  "name": "certificate",
                  "value": ""
                },
                {
                  "name": "forced",
                  "value": ""
                },
                {
                  "name": "claimsForced",
                  "value": ""
                }
              ]
            }
          },
          "docs": "SUPER users only\nRequires the privilege [`COMPANY_SECURITY_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        },
        {
          "info": {
            "name": "userApiKeyRevoke",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.gremlin.com/v1/companies/:identifier/users/:email/api-key/:api-key-id",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "path"
              },
              {
                "name": "email",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-key-id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Requires the privilege [`COMPANY_USERS_WRITE`](https://www.gremlin.com/docs/user-management/access-control/#privileges)"
        }
      ]
    }
  ],
  "bundled": true
}