{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchling AA Sequences Users API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/api/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/users",
            "params": [
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of ids. Matches all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.\n"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of a user. Restricts results to those with the specified name."
              },
              {
                "name": "nameIncludes",
                "value": "",
                "type": "query",
                "description": "Name substring of a user. Restricts results to those with names that include the provided substring."
              },
              {
                "name": "names.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, case insensitive.  Warning - this filter can be non-performant due to case insensitivity.\n"
              },
              {
                "name": "names.anyOf.caseSensitive",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, case sensitive.\n"
              },
              {
                "name": "modifiedAt",
                "value": "",
                "type": "query",
                "description": "Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.\n"
              },
              {
                "name": "memberOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of organization and/or team API IDs. Restricts results to users that are members of all given groups."
              },
              {
                "name": "adminOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of organization and/or team API IDs. Restricts results to users that are admins of all given groups."
              },
              {
                "name": "handles",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of handles. Restricts results to the users with the specified handles."
              },
              {
                "name": "email.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of emails. Maximum of 100. Restricts results to the users with the specified emails."
              },
              {
                "name": "passwordLastChangedAt",
                "value": "",
                "type": "query",
                "description": "Datetime, in RFC 3339 format. Supports the >, >=, <, <=, operators. Time zone defaults to UTC. Restricts results to users who have last changed their password in the specified range. e.g. > 2017-04-30. If \"null\" is provided returns users that have no password set (SAML).\n"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              },
              {
                "name": "nextToken",
                "value": "",
                "type": "query",
                "description": "Token for pagination"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns all users that the caller has permission to view. The following roles have view permission:\n  - tenant admins\n  - members of the user's organizations\n"
        },
        {
          "info": {
            "name": "Create a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a single user."
        },
        {
          "info": {
            "name": "Get a user by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/users/:user_id",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of user to get"
              }
            ]
          },
          "docs": "Returns a user by ID if the caller has permission to view. The following roles have view permission:\n  - tenant admins\n  - members of any of the user's organizations\n"
        },
        {
          "info": {
            "name": "Update a user by ID",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/users/:user_id",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of user to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a single user."
        },
        {
          "info": {
            "name": "Last user activity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/users/:user_id/activity",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of user to get"
              }
            ]
          },
          "docs": "Returns activity metadata for a specific user by ID. This currently includes lastSeen data.\n"
        },
        {
          "info": {
            "name": "User warehouse credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/users/:user_id/warehouse-credentials",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path",
                "description": "ID of user to get"
              }
            ]
          },
          "docs": "Returns the list of warehouse credential summaries for this user."
        },
        {
          "info": {
            "name": "Bulk Create Users",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/users:bulk-create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk Create Users."
        },
        {
          "info": {
            "name": "Bulk Update Users.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/users:bulk-update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "There is currently **no support** for swapping emails or handles between existing users in the same request.\n"
        }
      ]
    }
  ],
  "bundled": true
}