{
  "opencollection": "1.0.0",
  "info": {
    "name": "WorkOS admin-portal user-management.users API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "user-management.users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get an Email Verification Code",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.workos.com/user_management/email_verification/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the email verification code."
              }
            ]
          },
          "docs": "Get the details of an existing email verification code that can be used to send an email to a user for verification."
        },
        {
          "info": {
            "name": "Create a Password Reset Token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.workos.com/user_management/password_reset",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a one-time token that can be used to reset a user's password."
        },
        {
          "info": {
            "name": "Reset the Password",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.workos.com/user_management/password_reset/confirm",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets a new password using the `token` query parameter from the link that the user received. Successfully resetting the password will verify a user's email, if it hasn't been verified yet."
        },
        {
          "info": {
            "name": "Get a Password Reset Token",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.workos.com/user_management/password_reset/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the password reset token."
              }
            ]
          },
          "docs": "Get the details of an existing password reset token that can be used to reset a user's password."
        },
        {
          "info": {
            "name": "List Users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.workos.com/user_management/users",
            "params": [
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `before=\"obj_123\"` to fetch a new batch of objects before `\"obj_123\"`."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `after=\"obj_123\"` to fetch a new batch of objects after `\"obj_123\"`."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Upper limit on the number of objects to return, between `1` and `100`."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Order the results by the creation time. Supported values are `\"asc\"` (ascending), `\"desc\"` (descending), and `\"normal\"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending."
              },
              {
                "name": "organization",
                "value": "",
                "type": "query",
                "description": "Filter users by the organization they are a member of. Deprecated in favor of `organization_id`."
              },
              {
                "name": "organization_id",
                "value": "",
                "type": "query",
                "description": "Filter users by the organization they are a member of."
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter users by their email address."
              }
            ]
          },
          "docs": "Get a list of all of your existing users matching the criteria specified."
        },
        {
          "info": {
            "name": "Create a User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.workos.com/user_management/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new user in the current environment."
        },
        {
          "info": {
            "name": "Get a User by External ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.workos.com/user_management/users/external_id/:external_id",
            "params": [
              {
                "name": "external_id",
                "value": "",
                "type": "path",
                "description": "The external ID of the user."
              }
            ]
          },
          "docs": "Get the details of an existing user by an [external identifier](/authkit/metadata/external-identifiers)."
        },
        {
          "info": {
            "name": "Get a User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.workos.com/user_management/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique ID of the user."
              }
            ]
          },
          "docs": "Get the details of an existing user."
        },
        {
          "info": {
            "name": "Update a User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.workos.com/user_management/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique ID of the user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates properties of a user. The omitted properties will be left unchanged."
        },
        {
          "info": {
            "name": "Delete a User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.workos.com/user_management/users/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique ID of the user."
              }
            ]
          },
          "docs": "Permanently deletes a user in the current environment. It cannot be undone."
        },
        {
          "info": {
            "name": "Confirm Email Change",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.workos.com/user_management/users/:id/email_change/confirm",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique ID of the user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Confirms an email change using the one-time code received by the user."
        },
        {
          "info": {
            "name": "Send Email Change Code",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.workos.com/user_management/users/:id/email_change/send",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique ID of the user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sends an email that contains a one-time code used to change a user's email address."
        },
        {
          "info": {
            "name": "Verify Email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.workos.com/user_management/users/:id/email_verification/confirm",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the user."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verifies an email address using the one-time code received by the user."
        },
        {
          "info": {
            "name": "Send Verification Email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.workos.com/user_management/users/:id/email_verification/send",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the user."
              }
            ]
          },
          "docs": "Sends an email that contains a one-time code used to verify a user’s email address."
        },
        {
          "info": {
            "name": "Get User Identities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.workos.com/user_management/users/:id/identities",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique ID of the user."
              }
            ]
          },
          "docs": "Get a list of identities associated with the user. A user can have multiple associated identities after going through [identity linking](/authkit/identity-linking). Currently only OAuth identities are supported. More provider types may be added in the future."
        },
        {
          "info": {
            "name": "List Sessions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.workos.com/user_management/users/:id/sessions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the user."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `before=\"obj_123\"` to fetch a new batch of objects before `\"obj_123\"`."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `after=\"obj_123\"` to fetch a new batch of objects after `\"obj_123\"`."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Upper limit on the number of objects to return, between `1` and `100`."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Order the results by the creation time. Supported values are `\"asc\"` (ascending), `\"desc\"` (descending), and `\"normal\"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending."
              }
            ]
          },
          "docs": "Get a list of all active sessions for a specific user."
        }
      ]
    }
  ],
  "bundled": true
}