{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Users API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Change Password For User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/changePassword",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new user."
        },
        {
          "info": {
            "name": "Check if a mail is verified",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users/checkEmailVerified",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Check if a mail is already in use"
        },
        {
          "info": {
            "name": "Confirm User Email",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/registrationConfirmation",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "Token sent for Email Confirmation"
              }
            ]
          },
          "docs": "Confirm User Email"
        },
        {
          "info": {
            "name": "Get personal access token to User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/security/token",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "User Name of the User for which to get. (Default = `false`)"
              }
            ]
          },
          "docs": "Get a personal access token"
        },
        {
          "info": {
            "name": "Provide access token to User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/security/token",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Provide access token to User"
        },
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "team",
                "value": "",
                "type": "query",
                "description": "Filter users by team"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number users returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of users before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of users after this cursor"
              },
              {
                "name": "isAdmin",
                "value": "",
                "type": "query",
                "description": "Returns list of admin users if set to true"
              },
              {
                "name": "isBot",
                "value": "",
                "type": "query",
                "description": "Returns list of bot users if set to true"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a list of users. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params."
        },
        {
          "info": {
            "name": "Create a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new user."
        },
        {
          "info": {
            "name": "Update user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or Update a user."
        },
        {
          "info": {
            "name": "Get a user by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/name/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the user"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a user by `name`."
        },
        {
          "info": {
            "name": "Delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/users/name/:name",
            "params": [
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              },
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the user"
              }
            ]
          },
          "docs": "Users can't be deleted but are soft-deleted."
        },
        {
          "info": {
            "name": "Get a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a user by `id`"
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing user using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/users/:id",
            "params": [
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              }
            ]
          },
          "docs": "Users can't be deleted but are soft-deleted."
        },
        {
          "info": {
            "name": "Asynchronously delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/users/async/:id",
            "params": [
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              }
            ]
          },
          "docs": "Users can't be deleted but are soft-deleted."
        },
        {
          "info": {
            "name": "Export users in a team in CSV format",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/export",
            "params": [
              {
                "name": "team",
                "value": "",
                "type": "query",
                "description": "Name of the team to under which the users are imported to"
              }
            ]
          },
          "docs": "Export users in a team in CSV format"
        },
        {
          "info": {
            "name": "Export users in a team in CSV format",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/exportAsync",
            "params": [
              {
                "name": "team",
                "value": "",
                "type": "query",
                "description": "Name of the team to under which the users are imported to"
              }
            ]
          },
          "docs": "Export users in a team in CSV format"
        },
        {
          "info": {
            "name": "Generate a random password",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/generateRandomPwd"
          },
          "docs": "Generate a random password"
        },
        {
          "info": {
            "name": "Generate Password Reset Link",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users/generatePasswordResetLink",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate Password Reset Link"
        },
        {
          "info": {
            "name": "Generate JWT Token for a Bot User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/generateToken/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate JWT Token for a Bot User."
        },
        {
          "info": {
            "name": "Generate JWT Token for a User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users/generateToken",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate JWT Token for a user. Users with EDIT permission can generate tokens for bot users, and users can generate their own tokens. Regular users cannot generate tokens for other regular users."
        },
        {
          "info": {
            "name": "Get Authentication Mechanism for a Bot User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/auth-mechanism/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              }
            ]
          },
          "docs": "Get Authentication Mechanism for a Bot User."
        },
        {
          "info": {
            "name": "Get group type of teams for current logged in user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/loggedInUser/groupTeams"
          },
          "docs": "Get the group type of teams of user who is authenticated and is currently logged in."
        },
        {
          "info": {
            "name": "Get current logged in user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/loggedInUser",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              }
            ]
          },
          "docs": "Get the user who is authenticated and is currently logged in."
        },
        {
          "info": {
            "name": "Get JWT Token for a Bot User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/token/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              }
            ]
          },
          "docs": "Get JWT Token for a Bot User."
        },
        {
          "info": {
            "name": "Get CSV documentation for user import/export",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/documentation/csv"
          },
          "docs": "Get CSV documentation for user import/export"
        },
        {
          "info": {
            "name": "Get a version of the user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "User version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the user by given `id`"
        },
        {
          "info": {
            "name": "Import from CSV to create, and update teams.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/import",
            "params": [
              {
                "name": "team",
                "value": "",
                "type": "query",
                "description": "Name of the team to under which the users are imported to"
              },
              {
                "name": "dryRun",
                "value": "",
                "type": "query",
                "description": "Dry-run when true is used for validating the CSV without really importing it. (default=true)"
              }
            ]
          },
          "docs": "Import from CSV to create, and update teams."
        },
        {
          "info": {
            "name": "Import from CSV to create, and update teams asynchronously.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/importAsync",
            "params": [
              {
                "name": "team",
                "value": "",
                "type": "query",
                "description": "Name of the team to under which the users are imported to"
              },
              {
                "name": "dryRun",
                "value": "",
                "type": "query",
                "description": "Dry-run when true is used for validating the CSV without really importing it. (default=true)"
              }
            ]
          },
          "docs": "Import from CSV to create, and update teams asynchronously."
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/history",
            "params": [
              {
                "name": "startTs",
                "value": "",
                "type": "query",
                "description": "Start timestamp in milliseconds since epoch"
              },
              {
                "name": "endTs",
                "value": "",
                "type": "query",
                "description": "End timestamp in milliseconds since epoch"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of entity returned (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of entity versions before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of entity versions after this cursor"
              }
            ]
          },
          "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. "
        },
        {
          "info": {
            "name": "List online users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/online",
            "params": [
              {
                "name": "timeWindow",
                "value": "",
                "type": "query",
                "description": "Time window in minutes (default: 5). Use 0 for all time. Examples: 0 (all time), 1 (last minute), 5 (last 5 minutes), 60 (last hour), 1440 (last day)"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number users returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of users before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of users after this cursor"
              }
            ]
          },
          "docs": "Get a list of users who have been active within the specified time window. Admin access only."
        },
        {
          "info": {
            "name": "List assets owned by this user or their teams",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/:id/assets",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of assets returned. (1 to 1000, default = 100)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (default = 0)"
              }
            ]
          },
          "docs": "Get a paginated list of assets that are owned by this user or any of the teams they belong to. Use limit and offset query params for pagination."
        },
        {
          "info": {
            "name": "List assets owned by this user or their teams by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/name/:name/assets",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the user"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of assets returned. (1 to 1000, default = 100)"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (default = 0)"
              }
            ]
          },
          "docs": "Get a paginated list of assets that are owned by this user or any of the teams they belong to. Use limit and offset query params for pagination."
        },
        {
          "info": {
            "name": "List user versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/users/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the user"
              }
            ]
          },
          "docs": "Get a list of all the versions of a user identified by `id`"
        },
        {
          "info": {
            "name": "Login User with email (plain-text) and Password (encoded in base 64)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users/login",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Login User with email(plain-text) and Password (encoded in base 64)"
        },
        {
          "info": {
            "name": "Logout a User(Only called for saml and basic Auth)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users/logout",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Logout a User(Only called for saml and basic Auth)"
        },
        {
          "info": {
            "name": "Provide access token to User with refresh token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users/refresh",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Provide access token to User with refresh token"
        },
        {
          "info": {
            "name": "Register User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users/signup",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Register a new User"
        },
        {
          "info": {
            "name": "Resend Registration Token",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/resendRegistrationToken",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "query",
                "description": "Token sent for Email Confirmation Earlier"
              }
            ]
          },
          "docs": "Resend Registration Token"
        },
        {
          "info": {
            "name": "Reset Password For User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/users/password/reset",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reset User Password"
        },
        {
          "info": {
            "name": "Restore a soft deleted User.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a soft deleted User."
        },
        {
          "info": {
            "name": "Revoke personal access token to User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/security/token/revoke",
            "params": [
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "Username in case admin is revoking. (Default = `false`)"
              },
              {
                "name": "removeAll",
                "value": "",
                "type": "query",
                "description": "Remove All tokens of the user. (Default = `false`)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Revoke personal access token"
        },
        {
          "info": {
            "name": "Revoke JWT Token for a Bot User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/users/revokeToken",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Revoke JWT Token for a Bot User."
        }
      ]
    }
  ],
  "bundled": true
}