{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_accounts subpackage_users API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/users",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Email of guest to return"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "String to search for users by name and email"
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "Field to sort users by"
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query",
                "description": "Direction of sorting"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of users to return in a page (default 20)"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Based on pageSize, which page of users to return"
              }
            ]
          },
          "docs": "Gets a list of users"
        },
        {
          "info": {
            "name": "Create and Invite User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.x.flatfile.com/v1/users/invite",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates and invites a new user to your account."
        },
        {
          "info": {
            "name": "Resend User Invite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.x.flatfile.com/v1/users/:userId/resend-invite",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The user id"
              }
            ]
          },
          "docs": "Resends an invite to a user for your account."
        },
        {
          "info": {
            "name": "Get a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/users/:userId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The user id"
              }
            ]
          },
          "docs": "Gets a user"
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.x.flatfile.com/v1/users/:userId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The user id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a user"
        },
        {
          "info": {
            "name": "Delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.x.flatfile.com/v1/users/:userId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The user id"
              }
            ]
          },
          "docs": "Deletes a user"
        },
        {
          "info": {
            "name": "List User Roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/users/:userId/roles",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The user id"
              }
            ]
          },
          "docs": "Lists roles assigned to a user."
        },
        {
          "info": {
            "name": "Assign Role to User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.x.flatfile.com/v1/users/:userId/roles",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The user id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assigns a role to a user."
        },
        {
          "info": {
            "name": "Remove Role from User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.x.flatfile.com/v1/users/:userId/roles/:actorRoleId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The user id"
              },
              {
                "name": "actorRoleId",
                "value": "",
                "type": "path",
                "description": "The actor role id"
              }
            ]
          },
          "docs": "Removes a role from a user."
        }
      ]
    }
  ],
  "bundled": true
}