{
  "opencollection": "1.0.0",
  "info": {
    "name": "Integration API - Consumer to Extole Audiences Users API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{brand}.extole.io/v2/users",
            "params": [
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "accepts values: 'account'|'all'"
              }
            ]
          },
          "docs": "Returns all staff user accounts with access to the Extole console. Use the `scope` query parameter to restrict results to the current account or retrieve all accessible users."
        },
        {
          "info": {
            "name": "Create a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{brand}.extole.io/v2/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new staff user account with access to the Extole console. Returns the created user with its server-assigned id. An invitation email is sent to the new user."
        },
        {
          "info": {
            "name": "Get a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{brand}.extole.io/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns the staff user account for the specified id."
        },
        {
          "info": {
            "name": "Update a user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{brand}.extole.io/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the staff user account. Only fields present in the request body are changed. Returns the updated user."
        },
        {
          "info": {
            "name": "Delete a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{brand}.extole.io/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deactivates and removes the staff user account, revoking all console access."
        },
        {
          "info": {
            "name": "List user properties",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{brand}.extole.io/v2/users/:user_id/properties",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns all per-user property overrides for the specified staff user."
        },
        {
          "info": {
            "name": "Create a user property",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{brand}.extole.io/v2/users/:user_id/properties",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new per-user property override for the specified staff user. Returns the created property."
        },
        {
          "info": {
            "name": "Get a user property",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{brand}.extole.io/v2/users/:user_id/properties/:name",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Returns the per-user property override for the specified user and property name."
        },
        {
          "info": {
            "name": "Update a user property",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{brand}.extole.io/v2/users/:user_id/properties/:name",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the per-user property override for the specified staff user and property name. Returns the updated property."
        },
        {
          "info": {
            "name": "Delete a user property",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{brand}.extole.io/v2/users/:user_id/properties/:name",
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "name",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Removes the per-user property override for the specified staff user and property name."
        },
        {
          "info": {
            "name": "Reset user password",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{brand}.extole.io/v2/users/password-reset",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiates a password reset flow for the staff user identified by the request. A password-reset email is sent to the user's registered address."
        },
        {
          "info": {
            "name": "Resend user invite email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{brand}.extole.io/v2/users/resend-invite-email",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Resends the invitation email to a staff user who has not yet accepted their invitation."
        },
        {
          "info": {
            "name": "Unlock a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{brand}.extole.io/v2/users/:userId/unlock",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Unlocks a staff user account that has been locked due to failed login attempts, restoring console access."
        },
        {
          "info": {
            "name": "Update user password",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{brand}.extole.io/v2/users/update-password",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the password for the authenticated staff user account."
        }
      ]
    }
  ],
  "bundled": true
}