credentials object requires different properties depending on the phone provider (which is specified using the name property).\n"
},
{
"info": {
"name": "Get a Phone Provider",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/branding/phone/providers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve phone provider details. A list of fields to include or exclude may also be specified.\n"
},
{
"info": {
"name": "Update the Phone Provider",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/branding/phone/providers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a phone provider.\nThe credentials object requires different properties depending on the phone provider (which is specified using the name property).\n"
},
{
"info": {
"name": "Deletes a Phone Provider",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/branding/phone/providers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the configured phone provider.\n"
},
{
"info": {
"name": "Send a Test Phone Notification for the Configured Provider",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/branding/phone/providers/:id/try",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send a Test Phone Notification for the Configured Provider"
},
{
"info": {
"name": "Get a List of Phone Notification Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/branding/phone/templates",
"params": [
{
"name": "disabled",
"value": "",
"type": "query",
"description": "Whether the template is enabled (false) or disabled (true)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a List of Phone Notification Templates"
},
{
"info": {
"name": "Create a Phone Notification Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/branding/phone/templates",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a Phone Notification Template"
},
{
"info": {
"name": "Get a Phone Notification Template",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/branding/phone/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a Phone Notification Template"
},
{
"info": {
"name": "Update a Phone Notification Template",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/branding/phone/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a Phone Notification Template"
},
{
"info": {
"name": "Delete a Phone Notification Template",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/branding/phone/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a Phone Notification Template"
},
{
"info": {
"name": "Resets a Phone Notification Template Values",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/branding/phone/templates/:id/reset",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Resets a Phone Notification Template Values"
},
{
"info": {
"name": "Send a Test Phone Notification for the Configured Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/branding/phone/templates/:id/try",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send a Test Phone Notification for the Configured Template"
},
{
"info": {
"name": "Get Template for New Universal Login Experience",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/branding/templates/universal-login",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Template for New Universal Login Experience"
},
{
"info": {
"name": "Set Template for New Universal Login Experience",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/branding/templates/universal-login",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the Universal Login branding template.\n\nWhen content-type header is set to application/json:
\n{\n \"template\": \"<!DOCTYPE html>{% assign resolved_dir = dir | default: \"auto\" %}<html lang=\"{{locale}}\" dir=\"{{resolved_dir}}\"><head>{%- auth0:head -%}</head><body class=\"_widget-auto-layout\">{%- auth0:widget -%}</body></html>\"\n}\n\n\n\n When content-type header is set to text/html:\n`third_party_clients`, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with `client_id`."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of client grants, including the scopes associated with the application/API pair.\n"
},
{
"info": {
"name": "Create Client Grant",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/client-grants",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow."
},
{
"info": {
"name": "Get Client Grant",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/client-grants/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the client grant to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a single client grant, including the\nscopes associated with the application/API pair.\n"
},
{
"info": {
"name": "Update Client Grant",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/client-grants/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client grant to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a client grant."
},
{
"info": {
"name": "Delete Client Grant",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/client-grants/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client grant to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the Client Credential Flow from your machine-to-machine application.\n"
},
{
"info": {
"name": "Get the Organizations Associated to a Client Grant",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/client-grants/:id/organizations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client grant"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the Organizations Associated to a Client Grant"
}
]
},
{
"info": {
"name": "clients",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Clients",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/clients",
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Default value is 50, maximum value is 100"
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "is_global",
"value": "",
"type": "query",
"description": "Optional filter on the global client parameter."
},
{
"name": "is_first_party",
"value": "",
"type": "query",
"description": "Optional filter on whether or not a client is a first-party client."
},
{
"name": "app_type",
"value": "",
"type": "query",
"description": "Optional filter by a comma-separated list of application types."
},
{
"name": "external_client_id",
"value": "",
"type": "query",
"description": "Optional filter by the Client ID Metadata Document URI for CIMD-registered clients."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Advanced Query in Lucene syntax.
Permitted Queries:
client_id, app_type, name, and descript"
},
{
"info": {
"name": "Create a Client",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/clients",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new client (application or SSO integration). For more information, read Create Applications\n\">API Endpoints for Single Sign-On. \n\nNotes: \n- We recommend leaving the `client_secret` parameter unspecified to allow the generation of a safe secret.\n- The client_authentication_methods and Important: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.\n"
},
{
"info": {
"name": "Create a Client Credential",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/clients/:client_id/credentials",
"params": [
{
"name": "client_id",
"value": "",
"type": "path",
"description": "ID of the client."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.\n\nPublic Key
Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.\n\nSample: {\n \"credential_type\": \"public_key\",\n \"name\": \"string\",\n \"pem\": \"string\",\n \"alg\": \"RS256\",\n \"parse_expiry_from_cert\": false,\n \"expires_a"
},
{
"info": {
"name": "Get Client Credential Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/clients/:client_id/credentials/:credential_id",
"params": [
{
"name": "client_id",
"value": "",
"type": "path",
"description": "ID of the client."
},
{
"name": "credential_id",
"value": "",
"type": "path",
"description": "ID of the credential."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the details of a client credential.\n\nImportant: To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.\n"
},
{
"info": {
"name": "Update a Client Credential",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/clients/:client_id/credentials/:credential_id",
"params": [
{
"name": "client_id",
"value": "",
"type": "path",
"description": "ID of the client."
},
{
"name": "credential_id",
"value": "",
"type": "path",
"description": "ID of the credential."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow."
},
{
"info": {
"name": "Delete a Client Credential",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/clients/:client_id/credentials/:credential_id",
"params": [
{
"name": "client_id",
"value": "",
"type": "path",
"description": "ID of the client."
},
{
"name": "credential_id",
"value": "",
"type": "path",
"description": "ID of the credential to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow."
},
{
"info": {
"name": "Get Client by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/clients/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve client details by ID. Clients are SSO connections or Applications linked with your Auth0 tenant. A list of fields to include or exclude may also be specified. \nFor more information, read Applications in Auth0 and Single Sign-On.\n\n - \n The following properties can be retrieved with any of the scopes:\n
client_id, app_type<"
},
{
"info": {
"name": "Update a Client",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/clients/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates a client's settings. For more information, read Applications in Auth0 and Single Sign-On.\n\nNotes:\n- The `client_secret` and `signing_key` attributes can only be updated with the `update:client_keys` scope.\n- The client_authentication_methods and token_endpoint_auth_method properties are mutually exclusive. Use client_auth"
},
{
"info": {
"name": "Delete a Client",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/clients/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a client and related configuration (rules, connections, etc)."
},
{
"info": {
"name": "Get Enabled Connections for a Client",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/clients/:id/connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the client for which to retrieve enabled connections."
},
{
"name": "strategy",
"value": "",
"type": "query",
"description": "Provide strategies to only retrieve connections with such strategies"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields"
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "true if the fields specified are to be included in the result, false otherwise (defaults to true)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve all connections that are enabled for the specified Application, using checkpoint pagination. A list of fields to include or exclude for each connection may also be specified.\n\n - \n This endpoint requires the
read:connections scope and any one of read:clients or read:client_summary.\n \n - \n Note: The first time you call this endpoint, omit the
fromRotate Client Secrets."
}
]
},
{
"info": {
"name": "connection-profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Connection Profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connection-profiles",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 5."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.\n"
},
{
"info": {
"name": "Create a Connection Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/connection-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a Connection Profile.\n"
},
{
"info": {
"name": "Get Connection Profile Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connection-profiles/templates",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of Connection Profile Templates.\n"
},
{
"info": {
"name": "Get Connection Profile Template",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connection-profiles/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the connection-profile-template to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a Connection Profile Template.\n"
},
{
"info": {
"name": "Get Connection Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connection-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the connection-profile to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a single Connection Profile specified by ID.\n"
},
{
"info": {
"name": "Modify a Connection Profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/connection-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the connection profile to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the details of a specific Connection Profile.\n"
},
{
"info": {
"name": "Delete Connection Profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/connection-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the connection-profile to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a single Connection Profile specified by ID.\n"
}
]
},
{
"info": {
"name": "connections",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get All Connections",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections",
"params": [
{
"name": "per_page",
"value": "",
"type": "query",
"description": "The amount of entries per page. Defaults to 100 if not provided"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The page number. Zero based"
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "true if a query summary must be included in the result, false otherwise. Not returned when using checkpoint pagination. Default false."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "strategy",
"value": "",
"type": "query",
"description": "Provide strategies to only retrieve connections with such strategies"
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Provide the name of the connection to retrieve"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields"
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "true if the fields specified are to be included in the result, false otherwise (defaults to true)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves detailed list of all connections that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections. \n\nThis endpoint supports two types of pagination:\n\n- Offset pagination
\n- Checkpoint pagination
\n
\n\nCheckpoint pagination must be used if you need to ret"
},
{
"info": {
"name": "Create a Connection",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/connections",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a new connection according to the JSON object received in body.\n\nNote: If a connection with the same name was recently deleted and had a large number of associated users, the deletion may still be processing. Creating a new connection with that name before the deletion completes may fail or produce unexpected results. "
},
{
"info": {
"name": "Get a Connection",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to retrieve"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields"
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "true if the fields specified are to be included in the result, false otherwise (defaults to true)"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details for a specified connection along with options that can be used for identity provider configuration."
},
{
"info": {
"name": "Update a Connection",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to update"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update details for a specific connection, including option properties for identity provider configuration.\n\nNote: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option."
},
{
"info": {
"name": "Delete a Connection",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to delete"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.\n\nNote: If your connection has a large amount of users associated with it, please be aware that this operation can be long running after the response is returned and may impact concurrent create c"
},
{
"info": {
"name": "Get Enabled Clients for a Connection",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/clients",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection for which enabled clients are to be retrieved"
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve all clients that have the specified connection enabled.\n\nNote: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.\n"
},
{
"info": {
"name": "Update Enabled Clients for a Connection",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/connections/:id/clients",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to modify"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update Enabled Clients for a Connection"
},
{
"info": {
"name": "Get a Directory Provisioning Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/directory-provisioning",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to retrieve its directory provisioning configuration"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the directory provisioning configuration of a connection."
},
{
"info": {
"name": "Create a Directory Provisioning Configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/connections/:id/directory-provisioning",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to create its directory provisioning configuration"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a directory provisioning configuration for a connection.\n"
},
{
"info": {
"name": "Patch a Directory Provisioning Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/connections/:id/directory-provisioning",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to create its directory provisioning configuration"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the directory provisioning configuration of a connection.\n"
},
{
"info": {
"name": "Delete a Directory Provisioning Configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/connections/:id/directory-provisioning",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to delete its directory provisioning configuration"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the directory provisioning configuration of a connection."
},
{
"info": {
"name": "Get a Connection's Default Directory Provisioning Attribute Mapping",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/directory-provisioning/default-mapping",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to retrieve its directory provisioning configuration"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the directory provisioning default attribute mapping of a connection.\n"
},
{
"info": {
"name": "Request an On-demand Synchronization of the Directory",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/connections/:id/directory-provisioning/synchronizations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to trigger synchronization for"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Request an on-demand synchronization of the directory.\n"
},
{
"info": {
"name": "Get Synchronized Groups for a Directory Provisioning Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/directory-provisioning/synchronized-groups",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to list synchronized groups for."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the configured synchronized groups for a connection directory provisioning configuration.\n"
},
{
"info": {
"name": "Create or Replace Synchronized Group Selections for a Directory Provisioning Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/connections/:id/directory-provisioning/synchronized-groups",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to create or replace synchronized groups for"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create or replace the selected groups for a connection directory provisioning configuration.\n"
},
{
"info": {
"name": "Get Connection Keys",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/keys",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the connection"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Gets the connection keys for the Okta or OIDC connection strategy.\n"
},
{
"info": {
"name": "Create Connection Keys",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/connections/:id/keys",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the connection"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Provision initial connection keys for Okta or OIDC connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions.\n"
},
{
"info": {
"name": "Rotate Connection Keys",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/connections/:id/keys/rotate",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the connection"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Rotates the connection keys for the Okta or OIDC connection strategies.\n"
},
{
"info": {
"name": "Get a Connection's SCIM Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/scim-configuration",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to retrieve its SCIM configuration"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a scim configuration by its connectionId.\n"
},
{
"info": {
"name": "Create a SCIM Configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/connections/:id/scim-configuration",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to create its SCIM configuration"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a scim configuration for a connection.\n"
},
{
"info": {
"name": "Patch a Connection's SCIM Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/connections/:id/scim-configuration",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to update its SCIM configuration"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a scim configuration by its connectionId.\n"
},
{
"info": {
"name": "Delete a Connection's SCIM Configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/connections/:id/scim-configuration",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to delete its SCIM configuration"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a scim configuration by its connectionId.\n"
},
{
"info": {
"name": "Get a Connection's Default SCIM Mapping",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/scim-configuration/default-mapping",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to retrieve its default SCIM mapping"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a scim configuration's default mapping by its connectionId.\n"
},
{
"info": {
"name": "Get a Connection's SCIM Tokens",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/scim-configuration/tokens",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to retrieve its SCIM configuration"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves all scim tokens by its connection id.\n"
},
{
"info": {
"name": "Create a SCIM Token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/connections/:id/scim-configuration/tokens",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection to create its SCIM token"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a scim token for a scim client.\n"
},
{
"info": {
"name": "Delete a Connection's SCIM Token",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/connections/:id/scim-configuration/tokens/:tokenId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The connection id that owns the SCIM token to delete"
},
{
"name": "tokenId",
"value": "",
"type": "path",
"description": "The id of the scim token to delete"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a scim token by its connection id and tokenId.\n"
},
{
"info": {
"name": "Check Connection Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections/:id/status",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the connection to check"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the status of an ad/ldap connection referenced by its ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message"
},
{
"info": {
"name": "Delete a Connection User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/connections/:id/users",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the connection (currently only database connections are supported)"
},
{
"name": "email",
"value": "",
"type": "query",
"description": "The email of the user to delete"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.\n"
}
]
},
{
"info": {
"name": "connections-directory-provisionings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get a List of Directory Provisioning Configurations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections-directory-provisionings",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of directory provisioning configurations of a tenant.\n"
}
]
},
{
"info": {
"name": "connections-scim-configurations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get a List of SCIM Configurations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/connections-scim-configurations",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of SCIM configurations of a tenant.\n"
}
]
},
{
"info": {
"name": "custom-domains",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Custom Domains Configurations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/custom-domains",
"params": [
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Query in Lucene query string syntax."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to sort by. Only domain:1 (ascending order by domain) is supported at this time."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details on custom domains."
},
{
"info": {
"name": "Configure a New Custom Domain",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/custom-domains",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new custom domain.\n\nNote: The custom domain will need to be verified before it will accept\nrequests.\n\nOptional attributes that can be updated:\n\n- custom_client_ip_header\n- tls_policy\n\n\nTLS Policies:\n\n- recommended - for modern usage this includes TLS 1.2 only\n"
},
{
"info": {
"name": "Get the Default Domain",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/custom-domains/default",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the tenant's default domain.\n"
},
{
"info": {
"name": "Update the Default Custom Domain for the Tenant",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/custom-domains/default",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set the default custom domain for the tenant.\n"
},
{
"info": {
"name": "Get Custom Domain Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/custom-domains/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the custom domain to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a custom domain configuration and status."
},
{
"info": {
"name": "Update Custom Domain Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/custom-domains/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the custom domain to update"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a custom domain.\n\nThese are the attributes that can be updated:\n\n- custom_client_ip_header\n- tls_policy\n\nUpdating CUSTOM_CLIENT_IP_HEADER for a custom domain
To update the custom_client_ip_header for a domain, the body to\nsend should be:\n{ \"custom_client_ip_header\": \"cf-connecting-ip\" }
\n\nUpdating TLS_POLICY for a custom domain
To update the tls_policy for a domain, the body to send should be:\n{ \"tls_policy\": \"rec"
},
{
"info": {
"name": "Delete Custom Domain Configuration",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/custom-domains/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the custom domain to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a custom domain and stop serving requests for it."
},
{
"info": {
"name": "Test a Custom Domain",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/custom-domains/:id/test",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the custom domain to test."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Run the test process on a custom domain."
},
{
"info": {
"name": "Verify a Custom Domain",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/custom-domains/:id/verify",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the custom domain to verify."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Run the verification process on a custom domain.\n\nNote: Check the status field to see its verification status. Once verification is complete, it may take up to 10 minutes before the custom domain can start accepting requests.\n\nFor self_managed_certs, when the custom domain is verified for the first time, the response will also include the cname_api_key which you will need to configure your proxy. This key must be kept secret, and is used to validate the pro"
}
]
},
{
"info": {
"name": "device-credentials",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve Device Credentials",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/device-credentials",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. There is a maximum of 1000 results allowed from this endpoint."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
},
{
"name": "user_id",
"value": "",
"type": "query",
"description": "user_id of the devices to retrieve."
},
{
"name": "client_id",
"value": "",
"type": "query",
"description": "client_id of the devices to retrieve."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of credentials to retrieve. Must be `public_key`, `refresh_token` or `rotating_refresh_token`. The property will default to `refresh_token` when paging is requested"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.\n"
},
{
"info": {
"name": "Create a Device Public Key Credential",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/device-credentials",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a device credential public key to manage refresh token rotation for a given user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.\n\nWhen refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.\n"
},
{
"info": {
"name": "Delete a Device Credential",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/device-credentials/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the credential to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Permanently delete a device credential (such as a refresh token or public key) with the given ID."
}
]
},
{
"info": {
"name": "email-templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create an Email Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/email-templates",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create an email template."
},
{
"info": {
"name": "Get an Email Template",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/email-templates/:templateName",
"params": [
{
"name": "templateName",
"value": "",
"type": "path",
"description": "Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve an email template by pre-defined name. These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, and `async_approval`. The names `change_password`, and `password_reset` are also supported for legacy scenarios."
},
{
"info": {
"name": "Update an Email Template",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/email-templates/:templateName",
"params": [
{
"name": "templateName",
"value": "",
"type": "path",
"description": "Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an email template."
},
{
"info": {
"name": "Patch an Email Template",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/email-templates/:templateName",
"params": [
{
"name": "templateName",
"value": "",
"type": "path",
"description": "Template name. Can be `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, `mfa_oob_code`, `user_invitation`, `async_approval`, `change_password` (legacy), or `password_reset` (legacy)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify an email template."
}
]
},
{
"info": {
"name": "emails",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Email Provider",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/emails/provider",
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (dependent upon include_fields) from the result. Leave empty to retrieve `name` and `enabled`. Additional fields available include `credentials`, `default_from_address`, and `settings`."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.\n"
},
{
"info": {
"name": "Configure Email Provider",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/emails/provider",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create an email provider. The credentials object\nrequires different properties depending on the email provider (which is specified using the name property):\n\n mandrill requires api_keysendgrid requires api_key- \n
sparkpost requires api_key. Optionally, set region to eu to use\n th"
},
{
"info": {
"name": "Update Email Provider",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/emails/provider",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an email provider. The credentials object\nrequires different properties depending on the email provider (which is specified using the name property):\n\n mandrill requires api_keysendgrid requires api_key- \n
sparkpost requires api_key. Optionally, set region to eu to use\n th"
},
{
"info": {
"name": "Delete Email Provider",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/emails/provider",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the email provider.\n"
}
]
},
{
"info": {
"name": "event-streams",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Event Streams",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/event-streams",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Event Streams"
},
{
"info": {
"name": "Create an Event Stream",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/event-streams",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create an Event Stream"
},
{
"info": {
"name": "Get an Event Stream by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/event-streams/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the event stream."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an Event Stream by ID"
},
{
"info": {
"name": "Update an Event Stream",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/event-streams/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the event stream."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an Event Stream"
},
{
"info": {
"name": "Delete an Event Stream",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/event-streams/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the event stream."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an Event Stream"
},
{
"info": {
"name": "Get This Event Stream's Delivery History",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/event-streams/:id/deliveries",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the event stream."
},
{
"name": "statuses",
"value": "",
"type": "query",
"description": "Comma-separated list of statuses by which to filter"
},
{
"name": "event_types",
"value": "",
"type": "query",
"description": "Comma-separated list of event types by which to filter"
},
{
"name": "date_from",
"value": "",
"type": "query",
"description": "An RFC-3339 date-time for redelivery start, inclusive. Does not allow sub-second precision."
},
{
"name": "date_to",
"value": "",
"type": "query",
"description": "An RFC-3339 date-time for redelivery end, exclusive. Does not allow sub-second precision."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get This Event Stream's Delivery History"
},
{
"info": {
"name": "Get a Specific Event's Delivery History",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/event-streams/:id/deliveries/:event_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the event stream."
},
{
"name": "event_id",
"value": "",
"type": "path",
"description": "Unique identifier for the event"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a Specific Event's Delivery History"
},
{
"info": {
"name": "Redeliver Failed Events",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/event-streams/:id/redeliver",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the event stream."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Redeliver Failed Events"
},
{
"info": {
"name": "Redeliver a Single Failed Event by ID",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/event-streams/:id/redeliver/:event_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the event stream."
},
{
"name": "event_id",
"value": "",
"type": "path",
"description": "Unique identifier for the event"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Redeliver a Single Failed Event by ID"
},
{
"info": {
"name": "Send a Test Event to an Event Stream",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/event-streams/:id/test",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the event stream."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send a Test Event to an Event Stream"
}
]
},
{
"info": {
"name": "events",
"type": "folder"
},
"items": [
{
"info": {
"name": "Subscribe to Events Via Server-Sent Events (SSE)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/events",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Opaque token representing position in the stream. If not provided, stream will start from the latest events."
},
{
"name": "from_timestamp",
"value": "",
"type": "query",
"description": "RFC-3339 timestamp indicating where to start streaming events from. This should only be used on the initial query when a cursor may not be available. Subsequent requests should use the cursor (from) as it will be more accurate."
},
{
"name": "event_type",
"value": "",
"type": "query",
"description": "Event type(s) to listen for. Specify multiple times for multiple types (e.g., ?event_type=user.created&event_type=user.updated). If not provided, all event types will be streamed."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Subscribe to events via Server-Sent Events (SSE)"
}
]
},
{
"info": {
"name": "flows",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Flows",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/flows",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "hydrate",
"value": "",
"type": "query",
"description": "hydration param"
},
{
"name": "synchronous",
"value": "",
"type": "query",
"description": "flag to filter by sync/async flows"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Flows"
},
{
"info": {
"name": "Create a Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/flows",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a Flow"
},
{
"info": {
"name": "Get Flows Vault Connection List",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/flows/vault/connections",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Flows Vault Connection List"
},
{
"info": {
"name": "Create a Flows Vault Connection",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/flows/vault/connections",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a Flows Vault Connection"
},
{
"info": {
"name": "Get a Flows Vault Connection",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/flows/vault/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Flows Vault connection ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a Flows Vault Connection"
},
{
"info": {
"name": "Update a Flows Vault Connection",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/flows/vault/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Flows Vault connection ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a Flows Vault Connection"
},
{
"info": {
"name": "Delete a Flows Vault Connection",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/flows/vault/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Vault connection id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a Flows Vault Connection"
},
{
"info": {
"name": "Get Flow Executions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/flows/:flow_id/executions",
"params": [
{
"name": "flow_id",
"value": "",
"type": "path",
"description": "Flow id"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Flow Executions"
},
{
"info": {
"name": "Get a Flow Execution",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/flows/:flow_id/executions/:execution_id",
"params": [
{
"name": "flow_id",
"value": "",
"type": "path",
"description": "Flow id"
},
{
"name": "execution_id",
"value": "",
"type": "path",
"description": "Flow execution id"
},
{
"name": "hydrate",
"value": "",
"type": "query",
"description": "Hydration param"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a Flow Execution"
},
{
"info": {
"name": "Delete a Flow Execution",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/flows/:flow_id/executions/:execution_id",
"params": [
{
"name": "flow_id",
"value": "",
"type": "path",
"description": "Flows id"
},
{
"name": "execution_id",
"value": "",
"type": "path",
"description": "Flow execution identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a Flow Execution"
},
{
"info": {
"name": "Get a Flow",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/flows/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Flow identifier"
},
{
"name": "hydrate",
"value": "",
"type": "query",
"description": "hydration param"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a Flow"
},
{
"info": {
"name": "Update a Flow",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/flows/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Flow identifier"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a Flow"
},
{
"info": {
"name": "Delete a Flow",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/flows/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Flow id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a Flow"
}
]
},
{
"info": {
"name": "forms",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Forms",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/forms",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "hydrate",
"value": "",
"type": "query",
"description": "Query parameter to hydrate the response with additional data"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Forms"
},
{
"info": {
"name": "Create a Form",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/forms",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a Form"
},
{
"info": {
"name": "Get a Form",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/forms/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the form to retrieve."
},
{
"name": "hydrate",
"value": "",
"type": "query",
"description": "Query parameter to hydrate the response with additional data"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a Form"
},
{
"info": {
"name": "Update a Form",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/forms/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the form to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a Form"
},
{
"info": {
"name": "Delete a Form",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/forms/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the form to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a Form"
}
]
},
{
"info": {
"name": "grants",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Grants",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/grants",
"params": [
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "user_id",
"value": "",
"type": "query",
"description": "user_id of the grants to retrieve."
},
{
"name": "client_id",
"value": "",
"type": "query",
"description": "client_id of the grants to retrieve."
},
{
"name": "audience",
"value": "",
"type": "query",
"description": "audience of the grants to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the grants associated with your account. "
},
{
"info": {
"name": "Delete a Grant by User_id",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/grants",
"params": [
{
"name": "user_id",
"value": "",
"type": "query",
"description": "user_id of the grant to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a grant associated with your account. "
},
{
"info": {
"name": "Delete a Grant by Id",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/grants/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the grant to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a grant associated with your account. "
}
]
},
{
"info": {
"name": "groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get All Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/groups",
"params": [
{
"name": "connection_id",
"value": "",
"type": "query",
"description": "Filter groups by connection ID."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Filter groups by name."
},
{
"name": "external_id",
"value": "",
"type": "query",
"description": "Filter groups by external ID."
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Search for groups by name or external ID."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields"
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all groups in your tenant.\n"
},
{
"info": {
"name": "Get a Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/groups/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the group (service-generated)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a group by its ID.\n"
},
{
"info": {
"name": "Delete a Group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/groups/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the group (service-generated)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a group by its ID.\n"
},
{
"info": {
"name": "Get Group Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/groups/:id/members",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier for the group (service-generated)."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields"
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all users that are a member of this group.\n"
}
]
},
{
"info": {
"name": "guardian",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create a Multi-factor Authentication Enrollment Ticket",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/guardian/enrollments/ticket",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket, to a given user.\nCreate a multi-factor authentication (MFA) enrollment ticket, and optionally send an email with the created ticket to a given u"
},
{
"info": {
"name": "Get a Multi-factor Authentication Enrollment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/enrollments/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the enrollment to be retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details, such as status and type, for a specific multi-factor authentication enrollment registered to a user account."
},
{
"info": {
"name": "Delete a Multi-factor Authentication Enrollment",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/guardian/enrollments/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the enrollment to be deleted."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove a specific multi-factor authentication (MFA) enrollment from a user's account. This allows the user to re-enroll with MFA. For more information, review Reset User Multi-Factor Authentication and Recovery Codes."
},
{
"info": {
"name": "Get Factors and Multi-factor Authentication Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of all multi-factor authentication factors associated with your tenant."
},
{
"info": {
"name": "Get DUO Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/duo/settings",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the DUO account and factor configuration."
},
{
"info": {
"name": "Set the DUO Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/duo/settings",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set the DUO account configuration and other properties specific to this factor."
},
{
"info": {
"name": "Update the DUO Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/guardian/factors/duo/settings",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the DUO Configuration"
},
{
"info": {
"name": "Get Enabled Phone Factors",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/phone/message-types",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant."
},
{
"info": {
"name": "Update the Enabled Phone Factors",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/phone/message-types",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant."
},
{
"info": {
"name": "Get Twilio Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/phone/providers/twilio",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve configuration details for a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA. "
},
{
"info": {
"name": "Update Twilio Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/phone/providers/twilio",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the configuration of a Twilio phone provider that has been set up in your tenant. To learn more, review Configure SMS and Voice Notifications for MFA. "
},
{
"info": {
"name": "Get Phone Provider Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/phone/selected-provider",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of the multi-factor authentication phone provider configured for your tenant."
},
{
"info": {
"name": "Update Phone Provider Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/phone/selected-provider",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update Phone Provider Configuration"
},
{
"info": {
"name": "Get Enrollment and Verification Phone Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/phone/templates",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of the multi-factor authentication enrollment and verification templates for phone-type factors available in your tenant."
},
{
"info": {
"name": "Update Enrollment and Verification Phone Templates",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/phone/templates",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Customize the messages sent to complete phone enrollment and verification (subscription required)."
},
{
"info": {
"name": "Get APNS Push Notification Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/apns",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve configuration details for the multi-factor authentication APNS provider associated with your tenant."
},
{
"info": {
"name": "Update APNS Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/apns",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Overwrite all configuration details of the multi-factor authentication APNS provider associated with your tenant."
},
{
"info": {
"name": "Update APNs Provider Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/apns",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify configuration details of the multi-factor authentication APNS provider associated with your tenant."
},
{
"info": {
"name": "Overwrite FCM Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/fcm",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Overwrite all configuration details of the multi-factor authentication FCM provider associated with your tenant."
},
{
"info": {
"name": "Updates FCM Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/fcm",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify configuration details of the multi-factor authentication FCM provider associated with your tenant."
},
{
"info": {
"name": "Overwrite FCMV1 Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/fcmv1",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Overwrite all configuration details of the multi-factor authentication FCMV1 provider associated with your tenant."
},
{
"info": {
"name": "Updates FCMV1 Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/fcmv1",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify configuration details of the multi-factor authentication FCMV1 provider associated with your tenant."
},
{
"info": {
"name": "Get AWS SNS Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/sns",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review Configure Push Notifications for MFA. "
},
{
"info": {
"name": "Configure AWS SNS Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/sns",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Configure the AWS SNS push notification provider configuration (subscription required)."
},
{
"info": {
"name": "Update AWS SNS Configuration",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/sns",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Configure the AWS SNS push notification provider configuration (subscription required)."
},
{
"info": {
"name": "Get Push Notification Provider",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/selected-provider",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA. "
},
{
"info": {
"name": "Update Push Notification Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/push-notification/selected-provider",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify the push notification provider configured for your tenant. For more information, review Configure Push Notifications for MFA. "
},
{
"info": {
"name": "Get Twilio SMS Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/sms/providers/twilio",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the Twilio SMS provider configuration (subscription required).\n\n A new endpoint is available to retrieve the Twilio configuration related to phone factors (phone Twilio configuration). It has the same payload as this one. Please use it instead."
},
{
"info": {
"name": "Update Twilio SMS Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/sms/providers/twilio",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint has been deprecated. To complete this action, use the Update Twilio phone configuration endpoint.\n\n Previous functionality: Update the Twilio SMS provider configuration."
},
{
"info": {
"name": "Get SMS Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/sms/selected-provider",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint has been deprecated. To complete this action, use the Retrieve phone configuration endpoint instead.\n\n Previous functionality: Retrieve details for the multi-factor authentication SMS provider configured for your tenant."
},
{
"info": {
"name": "Update SMS Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/sms/selected-provider",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint has been deprecated. To complete this action, use the Update phone configuration endpoint instead.\n\n Previous functionality: Update the multi-factor authentication SMS provider configuration in your tenant."
},
{
"info": {
"name": "Get SMS Enrollment and Verification Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/factors/sms/templates",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint has been deprecated. To complete this action, use the Retrieve enrollment and verification phone templates endpoint instead.\n\n Previous function: Retrieve details of SMS enrollment and verification templates configured for your tenant."
},
{
"info": {
"name": "Update SMS Enrollment and Verification Templates",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/sms/templates",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "This endpoint has been deprecated. To complete this action, use the Update enrollment and verification phone templates endpoint instead.\n\n Previous functionality: Customize the messages sent to complete SMS enrollment and verification."
},
{
"info": {
"name": "Update Multi-factor Authentication Type",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/guardian/factors/:name",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "Factor name. Can be `sms`, `push-notification`, `email`, `duo` `otp` `webauthn-roaming`, `webauthn-platform`, or `recovery-code`."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor."
},
{
"info": {
"name": "Get Multi-factor Authentication Policies",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/guardian/policies",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the multi-factor authentication (MFA) policies configured for your tenant.\n\nThe following policies are supported:\n\nall-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.
\n\nNote: The confidence-score policy is part of the multi-factor authentication (MFA) policies for your tenant.\n\nThe following policies are supported:\n\nall-applications policy prompts with MFA for all logins.confidence-score policy prompts with MFA only for low confidence logins.
\n\nNote: The confidence-score policy is part of the hooks. Accepts a list of fields to include or exclude in the result.\n"
},
{
"info": {
"name": "Create a Hook",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/hooks",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new hook.\n"
},
{
"info": {
"name": "Get a Hook",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/hooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the hook to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include in the result. Leave empty to retrieve all fields."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a hook by its ID. Accepts a list of fields to include in the result.\n"
},
{
"info": {
"name": "Update a Hook",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/hooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the hook to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing hook.\n"
},
{
"info": {
"name": "Delete a Hook",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/hooks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the hook to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a hook.\n"
},
{
"info": {
"name": "Get Hook Secrets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/hooks/:id/secrets",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the hook to retrieve secrets from."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a hook's secrets by the ID of the hook. \n"
},
{
"info": {
"name": "Add Hook Secrets",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/hooks/:id/secrets",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the hook to retrieve"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Add one or more secrets to an existing hook. Accepts an object of key-value pairs, where the key is the name of the secret. A hook can have a maximum of 20 secrets. \n"
},
{
"info": {
"name": "Update Hook Secrets",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/hooks/:id/secrets",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the hook whose secrets to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update one or more existing secrets for an existing hook. Accepts an object of key-value pairs, where the key is the name of the existing secret. \n"
},
{
"info": {
"name": "Delete Hook Secrets",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/hooks/:id/secrets",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the hook whose secrets to delete."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete one or more existing secrets for a given hook. Accepts an array of secret names to delete. "
}
]
},
{
"info": {
"name": "jobs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create Export Users Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/jobs/users-exports",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Export all users to a file via a long-running job."
},
{
"info": {
"name": "Create Import Users Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/jobs/users-imports",
"body": {
"type": "multipart-form",
"data": []
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Import users from a formatted file into a connection via a long-running job. When importing users, with or without upsert, the `email_verified` is set to `false` when the email address is added or updated. Users must verify their email address. To avoid this behavior, set `email_verified` to `true` in the imported data."
},
{
"info": {
"name": "Send an Email Address Verification Email",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/jobs/verification-email",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Send an email to the specified user that asks them to click a link to verify their email address.\n\nNote: You must have the `Status` toggle enabled for the verification email template for the email to be sent."
},
{
"info": {
"name": "Get a Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/jobs/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the job."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a job. Useful to check its status."
},
{
"info": {
"name": "Get Job Error Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/jobs/:id/errors",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the job."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve error details of a failed job."
}
]
},
{
"info": {
"name": "keys",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Custom Signing Keys",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/keys/custom-signing",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get entire jwks representation of custom signing keys."
},
{
"info": {
"name": "Create or Replace Custom Signing Keys",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/keys/custom-signing",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create or replace entire jwks representation of custom signing keys."
},
{
"info": {
"name": "Delete Custom Signing Keys",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/keys/custom-signing",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete entire jwks representation of custom signing keys."
},
{
"info": {
"name": "Get All Encryption Keys",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/keys/encryption",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Default value is 50, maximum value is 100."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of all the encryption keys associated with your tenant."
},
{
"info": {
"name": "Create the New Encryption Key",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/keys/encryption",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create the new, pre-activated encryption key, without the key material."
},
{
"info": {
"name": "Rekey the Key Hierarchy",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/keys/encryption/rekey",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Perform rekeying operation on the key hierarchy."
},
{
"info": {
"name": "Get the Encryption Key by Its Key Id",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/keys/encryption/:kid",
"params": [
{
"name": "kid",
"value": "",
"type": "path",
"description": "Encryption key ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of the encryption key with the given ID."
},
{
"info": {
"name": "Import the Encryption Key",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/keys/encryption/:kid",
"params": [
{
"name": "kid",
"value": "",
"type": "path",
"description": "Encryption key ID"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Import wrapped key material and activate encryption key."
},
{
"info": {
"name": "Delete the Encryption Key by Its Key Id",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/keys/encryption/:kid",
"params": [
{
"name": "kid",
"value": "",
"type": "path",
"description": "Encryption key ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete the custom provided encryption key with the given ID and move back to using native encryption key."
},
{
"info": {
"name": "Create the Public Wrapping Key",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/keys/encryption/:kid/wrapping-key",
"params": [
{
"name": "kid",
"value": "",
"type": "path",
"description": "Encryption key ID"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create the public wrapping key to wrap your own encryption key material."
},
{
"info": {
"name": "Get All Application Signing Keys",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/keys/signing",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of all the application signing keys associated with your tenant."
},
{
"info": {
"name": "Rotate the Application Signing Key",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/keys/signing/rotate",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Rotate the application signing key of your tenant."
},
{
"info": {
"name": "Get an Application Signing Key by Its Key Id",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/keys/signing/:kid",
"params": [
{
"name": "kid",
"value": "",
"type": "path",
"description": "Key id of the key to retrieve"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of the application signing key with the given ID."
},
{
"info": {
"name": "Revoke an Application Signing Key by Its Key Id",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/keys/signing/:kid/revoke",
"params": [
{
"name": "kid",
"value": "",
"type": "path",
"description": "Key id of the key to revoke"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revoke the application signing key with the given ID."
}
]
},
{
"info": {
"name": "log-streams",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Log Streams",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/log-streams",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details on [log streams](https://auth0.com/docs/logs/streams).\n\n**Sample Response**\n\n```json\n[{\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"eventbridge\",\n \"status\": \"active|paused|suspended\",\n \"sink\": {\n \"awsAccountId\": \"string\",\n \"awsRegion\": \"string\",\n \"awsPartnerEventSource\": \"string\"\n }\n}, {\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"http\",\n \"status\": \"active|paused|suspended\",\n \"sink\": {\n \"httpContentFormat\": \"JSONLINES|JSONARRAY\",\n \"httpContentType\":"
},
{
"info": {
"name": "Create a Log Stream",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/log-streams",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a log stream.\n\n**Log Stream Types**\n\nThe `type` of log stream being created determines the properties required in the `sink` payload.\n\n**HTTP Stream**\n\nFor an `http` Stream, the `sink` properties are listed in the payload below.\n\n**Request:**\n```json\n{\n \"name\": \"string\",\n \"type\": \"http\",\n \"sink\": {\n \"httpEndpoint\": \"string\",\n \"httpContentType\": \"string\",\n \"httpContentFormat\": \"JSONLINES|JSONARRAY\",\n \"httpAuthorization\": \"string\"\n }\n}\n```\n\n**Response:**\n```json\n{\n \"id\": \"s"
},
{
"info": {
"name": "Get Log Stream by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/log-streams/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the log stream to get"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a log stream configuration and status.\n\n**Sample responses**\n\n**Amazon EventBridge Log Stream**\n\n```json\n{\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"eventbridge\",\n \"status\": \"active|paused|suspended\",\n \"sink\": {\n \"awsAccountId\": \"string\",\n \"awsRegion\": \"string\",\n \"awsPartnerEventSource\": \"string\"\n }\n}\n```\n\n**HTTP Log Stream**\n\n```json\n{\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"http\",\n \"status\": \"active|paused|suspended\",\n \"sink\": {\n \"httpContentFormat\": \""
},
{
"info": {
"name": "Update a Log Stream",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/log-streams/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the log stream to get"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a log stream.\n\n**Examples of how to use the PATCH endpoint.**\n\nThe following fields may be updated in a PATCH operation:\n\n- name\n- status\n- sink\n\nNote: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.\n\n**Update the status of a log stream**\n\n```json\n{\n \"status\": \"active|paused\"\n}\n```\n\n**Update the name of a log stream**\n\n```json\n{\n \"name\": \"string\"\n}\n```\n\n**Update the sink properties of a stream of type `http`**\n\n```json\n{\n \"sink\": {\n \"http"
},
{
"info": {
"name": "Delete Log Stream",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/log-streams/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the log stream to delete"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a log stream.\n"
}
]
},
{
"info": {
"name": "logs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search Log Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/logs",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": " Number of results per page. Paging is disabled if parameter not sent. Default: 50. Max value: 100"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to use for sorting appended with :1 for ascending and :-1 for descending. e.g. date:-1"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)"
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results as an array when false (default). Return results inside an object that also contains a total result count when true."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Log Event Id from which to start selection from."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of entries to retrieve when using the from parameter. Default 50, max 100"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Retrieves logs that match the specified search criteria. This parameter can be combined with all the others in the /api/logs endpoint but is specified separately for clarity.\nIf no fields are provided a case insensitive 'starts with' search is performed on all of the following fields: client_name, connection, user_name. Otherwise, you can specify multiple fields and specify the search using the %field%:%search%, for example: application:node user:\"John@contoso.com\".\nValues specified without quotes are matched using a case insensitive 'starts with' search. If quotes are used a case insensitve exact search is used. If multiple fields are used, the AND operator is used to join the clauses."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).\n\nSet custom search criteria using the q parameter, or search from a specific log ID (\"search from checkpoint\").\n\nFor more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.\n\nTo set custom search criteria, use the following parameters:
\n\nfield:order
where order is 1 for ascending and -1 for descending. e.g. created_at:1. We currently support sorting by the following fields: name, display_name and created_at."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.\n\nThis endpoint supports two types of pagination:\n
\n- Offset pagination
\n- Checkpoint pagination
\n
\n\nCheckpoint pagination must be used if you need to retrieve more than 1000 organizations.\n\nCheckpoint Pagination
\n\nTo search by checkpoint, use the following parameters:\n\nfrom: Optional id from which to start selection.t"
},
{
"info": {
"name": "Create an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/organizations",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.\n"
},
{
"info": {
"name": "Get Organization by Name",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/name/:name",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "name of the organization to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a single Organization specified by name.\n"
},
{
"info": {
"name": "Get Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a single Organization specified by ID. \n"
},
{
"info": {
"name": "Modify an Organization",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/organizations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the details of a specific Organization, such as name and display name, branding options, and metadata.\n"
},
{
"info": {
"name": "Delete Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/organizations/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove an Organization from your tenant. This action cannot be undone. \n\nNote: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.\n"
},
{
"info": {
"name": "Get Client Grants Associated to an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/client-grants",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "audience",
"value": "",
"type": "query",
"description": "Optional filter on audience of the client grant."
},
{
"name": "client_id",
"value": "",
"type": "query",
"description": "Optional filter on client_id of the client grant."
},
{
"name": "grant_ids",
"value": "",
"type": "query",
"description": "Optional filter on the ID of the client grant. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../client-grants?grant_ids=id1&grant_ids=id2"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Client Grants Associated to an Organization"
},
{
"info": {
"name": "Associate a Client Grant with an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/organizations/:id/client-grants",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Associate a Client Grant with an Organization"
},
{
"info": {
"name": "Remove a Client Grant from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/organizations/:id/client-grants/:grant_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "grant_id",
"value": "",
"type": "path",
"description": "The Client Grant ID to remove from the organization"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove a Client Grant from an Organization"
},
{
"info": {
"name": "Get Connections Associated with an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "is_enabled",
"value": "",
"type": "query",
"description": "Filter connections by enabled status."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get Connections Associated with an Organization"
},
{
"info": {
"name": "Adds a Connection to an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/organizations/:id/connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Adds a Connection to an Organization"
},
{
"info": {
"name": "Get a Specific Connection Associated with an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/connections/:connection_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connection_id",
"value": "",
"type": "path",
"description": "Connection identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a Specific Connection Associated with an Organization"
},
{
"info": {
"name": "Update a Connection for an Organization",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/organizations/:id/connections/:connection_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connection_id",
"value": "",
"type": "path",
"description": "Connection identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a Connection for an Organization"
},
{
"info": {
"name": "Delete a Connection from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/organizations/:id/connections/:connection_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connection_id",
"value": "",
"type": "path",
"description": "Connection identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a Connection from an Organization"
},
{
"info": {
"name": "Retrieve All Organization Discovery Domains",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/discovery-domains",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve list of all organization discovery domains associated with the specified organization.\nThis endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.\n"
},
{
"info": {
"name": "Create an Organization Discovery Domain",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/organizations/:id/discovery-domains",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new discovery domain for an organization."
},
{
"info": {
"name": "Retrieve an Organization Discovery Domain by Domain Name",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/discovery-domains/name/:discovery_domain",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "discovery_domain",
"value": "",
"type": "path",
"description": "Domain name of the discovery domain."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a single organization discovery domain specified by domain name.\nThis endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.\n"
},
{
"info": {
"name": "Retrieve an Organization Discovery Domain by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/discovery-domains/:discovery_domain_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "discovery_domain_id",
"value": "",
"type": "path",
"description": "ID of the discovery domain."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a single organization discovery domain specified by ID.\nThis endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.\n"
},
{
"info": {
"name": "Update an Organization Discovery Domain",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/organizations/:id/discovery-domains/:discovery_domain_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "discovery_domain_id",
"value": "",
"type": "path",
"description": "ID of the discovery domain to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The status field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).\n"
},
{
"info": {
"name": "Delete an Organization Discovery Domain",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/organizations/:id/discovery-domains/:discovery_domain_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the organization."
},
{
"name": "discovery_domain_id",
"value": "",
"type": "path",
"description": "ID of the discovery domain."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove a discovery domain from an organization. This action cannot be undone. "
},
{
"info": {
"name": "Get Connections Enabled for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/enabled_connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.\n"
},
{
"info": {
"name": "Add Connections to an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/organizations/:id/enabled_connections",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.\n\nConnections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.\n"
},
{
"info": {
"name": "Get an Enabled Connection for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/enabled_connections/:connectionId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connectionId",
"value": "",
"type": "path",
"description": "Connection identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.\n"
},
{
"info": {
"name": "Update the Connection of an Organization",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/organizations/:id/enabled_connections/:connectionId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connectionId",
"value": "",
"type": "path",
"description": "Connection identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify the details of a specific connection currently enabled for an Organization.\n"
},
{
"info": {
"name": "Delete Connections from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/organizations/:id/enabled_connections/:connectionId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "connectionId",
"value": "",
"type": "path",
"description": "Connection identifier."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate. \n\nNote: This action does not remove the connection from your tenant.\n"
},
{
"info": {
"name": "Get Invitations to an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/invitations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "When true, return results inside an object that also contains the start and limit. When false (default), a direct array of results is returned. We do not yet support returning the total invitations count."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false). Defaults to true."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to sort by. Use field:order where order is 1 for ascending and -1 for descending Defaults to created_at:-1."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review Invite Organization Members. \n"
},
{
"info": {
"name": "Create Invitations to an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/organizations/:id/invitations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review Invite Organization Members. \n"
},
{
"info": {
"name": "Get a Specific Invitation to an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/invitations/:invitation_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "invitation_id",
"value": "",
"type": "path",
"description": "The id of the user invitation."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false). Defaults to true."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a Specific Invitation to an Organization"
},
{
"info": {
"name": "Delete an Invitation to an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/organizations/:id/invitations/:invitation_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "invitation_id",
"value": "",
"type": "path",
"description": "The id of the user invitation."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an Invitation to an Organization"
},
{
"info": {
"name": "Get Members Who Belong to an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/members",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List organization members.\nThis endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it.\n\n\n - \n Use the
fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.\n \n - \n Member roles are not sent by default. Use
fields=roles to retrieve the roles assig"
},
{
"info": {
"name": "Add Members to an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/organizations/:id/members",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set one or more existing users as members of a specific Organization.\n\nTo add a user to an Organization through this action, the user must already exist in your tenant. If a user does not yet exist, you can invite them to create an account, manually create them through the Auth0 Dashboard, or use the Management API.\n"
},
{
"info": {
"name": "Delete Members from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/organizations/:id/members",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete Members from an Organization"
},
{
"info": {
"name": "Get User Roles Assigned to an Organization Member",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/organizations/:id/members/:user_id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to associate roles with."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve detailed list of roles assigned to a given user within the context of a specific Organization. \n\nUsers can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included.\n"
},
{
"info": {
"name": "Assign User Roles to an Organization Member",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/organizations/:id/members/:user_id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to associate roles with."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign one or more roles to a user to determine their access for a specific Organization.\n\nUsers can be members of multiple Organizations with unique roles assigned for each membership. This action assigns roles to a user only for the specified Organization. Roles cannot be assigned to a user across multiple Organizations in the same call.\n"
},
{
"info": {
"name": "Delete User Roles from an Organization Member",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/organizations/:id/members/:user_id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Organization identifier."
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "User ID of the organization member to remove roles from."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove one or more Organization-specific roles from a given user.\n\nUsers can be members of multiple Organizations with unique roles assigned for each membership. This action removes roles from a user in relation to the specified Organization. Roles assigned to the user within a different Organization cannot be managed in the same call.\n"
}
]
},
{
"info": {
"name": "prompts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Prompt Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/prompts",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features."
},
{
"info": {
"name": "Update Prompt Settings",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/prompts",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the Universal Login configuration of your tenant. This includes the Identifier First Authentication and WebAuthn with Device Biometrics for MFA features."
},
{
"info": {
"name": "Get Render Setting Configurations for All Screens",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/prompts/rendering",
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (default: true) or excluded (false)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Maximum value is 100, default value is 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total configuration count (true) or as a direct array of results (false, default)."
},
{
"name": "prompt",
"value": "",
"type": "query",
"description": "Name of the prompt to filter by"
},
{
"name": "screen",
"value": "",
"type": "query",
"description": "Name of the screen to filter by"
},
{
"name": "rendering_mode",
"value": "",
"type": "query",
"description": "Rendering mode to filter by"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get render setting configurations for all screens."
},
{
"info": {
"name": "Update Render Settings for Multiple Screens",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/prompts/rendering",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Learn more about configuring render settings for advanced customization.\n"
},
{
"info": {
"name": "Get Custom Text for a Prompt",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/prompts/:prompt/custom-text/:language",
"params": [
{
"name": "prompt",
"value": "",
"type": "path",
"description": "Name of the prompt."
},
{
"name": "language",
"value": "",
"type": "path",
"description": "Language to update."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve custom text for a specific prompt and language."
},
{
"info": {
"name": "Set Custom Text for a Specific Prompt",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/prompts/:prompt/custom-text/:language",
"params": [
{
"name": "prompt",
"value": "",
"type": "path",
"description": "Name of the prompt."
},
{
"name": "language",
"value": "",
"type": "path",
"description": "Language to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set custom text for a specific prompt. Existing texts will be overwritten."
},
{
"info": {
"name": "Get Partials for a Prompt",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/prompts/:prompt/partials",
"params": [
{
"name": "prompt",
"value": "",
"type": "path",
"description": "Name of the prompt."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get template partials for a prompt"
},
{
"info": {
"name": "Set Partials for a Prompt",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/prompts/:prompt/partials",
"params": [
{
"name": "prompt",
"value": "",
"type": "path",
"description": "Name of the prompt."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Set template partials for a prompt"
},
{
"info": {
"name": "Get Render Settings for a Screen",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/prompts/:prompt/screen/:screen/rendering",
"params": [
{
"name": "prompt",
"value": "",
"type": "path",
"description": "Name of the prompt"
},
{
"name": "screen",
"value": "",
"type": "path",
"description": "Name of the screen"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get render settings for a screen."
},
{
"info": {
"name": "Update Render Settings for a Screen",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/prompts/:prompt/screen/:screen/rendering",
"params": [
{
"name": "prompt",
"value": "",
"type": "path",
"description": "Name of the prompt"
},
{
"name": "screen",
"value": "",
"type": "path",
"description": "Name of the screen"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Learn more about configuring render settings for advanced customization.\n"
}
]
},
{
"info": {
"name": "refresh-tokens",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Refresh Tokens",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/refresh-tokens",
"params": [
{
"name": "user_id",
"value": "",
"type": "query",
"description": "ID of the user whose refresh tokens to retrieve. Required."
},
{
"name": "client_id",
"value": "",
"type": "query",
"description": "Filter results by client ID. Only valid when user_id is provided."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "An opaque cursor from which to start the selection (exclusive). Expires after 24 hours. Obtained from the next property of a previous response."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending."
},
{
"info": {
"name": "Revoke Refresh Tokens",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/refresh-tokens/revoke",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revoke refresh tokens in bulk by ID list, user, user+client, or client."
},
{
"info": {
"name": "Get a Refresh Token",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/refresh-tokens/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID refresh token to retrieve"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve refresh token information."
},
{
"info": {
"name": "Update a Refresh Token",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/refresh-tokens/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the refresh token to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a refresh token by its ID."
},
{
"info": {
"name": "Delete a Refresh Token",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/refresh-tokens/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the refresh token to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a refresh token by its ID."
}
]
},
{
"info": {
"name": "resource-servers",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Resource Servers",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/resource-servers",
"params": [
{
"name": "identifiers",
"value": "",
"type": "query",
"description": "An optional filter on the resource server identifier. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../resource-servers?identifiers=id1&identifiers=id2"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of all APIs associated with your tenant."
},
{
"info": {
"name": "Create a Resource Server",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/resource-servers",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new API associated with your tenant. Note that all new APIs must be registered with Auth0. For more information, read APIs."
},
{
"info": {
"name": "Get a Resource Server",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/resource-servers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID or audience of the resource server to retrieve."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve API details with the given ID."
},
{
"info": {
"name": "Update a Resource Server",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/resource-servers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID or audience of the resource server to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Change an existing API setting by resource server ID. For more information, read API Settings."
},
{
"info": {
"name": "Delete a Resource Server",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/resource-servers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID or the audience of the resource server to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete an existing API by ID. For more information, read API Settings."
}
]
},
{
"info": {
"name": "risk-assessments",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Risk Assessment Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/risk-assessments/settings",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Gets the tenant settings for risk assessments"
},
{
"info": {
"name": "Update Risk Assessment Settings",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/risk-assessments/settings",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates the tenant settings for risk assessments"
},
{
"info": {
"name": "Get New Device Assessor",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/risk-assessments/settings/new-device",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Gets the risk assessment settings for the new device assessor"
},
{
"info": {
"name": "Update New Device Assessor",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/risk-assessments/settings/new-device",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates the risk assessment settings for the new device assessor"
}
]
},
{
"info": {
"name": "roles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Roles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/roles",
"params": [
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "name_filter",
"value": "",
"type": "query",
"description": "Optional filter on name (case-insensitive)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve detailed list of user roles created in your tenant.\n\nNote: The returned list does not include standard roles available for tenant members, such as Admin or Support Access.\n"
},
{
"info": {
"name": "Create a Role",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/roles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a user role for Role-Based Access Control.\n\nNote: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions.\n"
},
{
"info": {
"name": "Get a Role",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the role to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a specific user role specified by ID.\n"
},
{
"info": {
"name": "Update a Role",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the role to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify the details of a specific user role specified by ID.\n"
},
{
"info": {
"name": "Delete a Role",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the role to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a specific user role from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.\n"
},
{
"info": {
"name": "Get Permissions Granted by Role",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/roles/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the role to list granted permissions."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.\n"
},
{
"info": {
"name": "Associate Permissions with a Role",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/roles/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the role to add permissions to."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Add one or more permissions to a specified user role.\n"
},
{
"info": {
"name": "Remove Permissions from a Role",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/roles/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the role to remove permissions from."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove one or more permissions from a specified user role.\n"
},
{
"info": {
"name": "Get a Role's Users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/roles/:id/users",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the role to retrieve a list of users associated with."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve list of users associated with a specific role. For Dashboard instructions, review View Users Assigned to Roles.\n\nThis endpoint supports two types of pagination:\n\n- Offset pagination
\n- Checkpoint pagination
\n
\n\nCheckpoint pagination must be used if you need to retrieve more than 1000 organization members.\n\nCheckpoint Pagination
\n\nTo search b"
},
{
"info": {
"name": "Assign Users to a Role",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/roles/:id/users",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the role to assign users to."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign one or more users to an existing user role. To learn more, review Role-Based Access Control.\n\nNote: New roles cannot be created through this action.\n"
}
]
},
{
"info": {
"name": "rules",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/rules",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "enabled",
"value": "",
"type": "query",
"description": "Optional filter on whether a rule is enabled (true) or disabled (false)."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a filtered list of rules. Accepts a list of fields to include or exclude.\n"
},
{
"info": {
"name": "Create a Rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/rules",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new rule.\n\nNote: Changing a rule's stage of execution from the default login_success can change the rule's function signature to have user omitted.\n"
},
{
"info": {
"name": "Get a Rule",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/rules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the rule to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve rule details. Accepts a list of fields to include or exclude in the result.\n"
},
{
"info": {
"name": "Update a Rule",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/rules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the rule to retrieve."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update an existing rule.\n"
},
{
"info": {
"name": "Delete a Rule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/rules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the rule to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a rule.\n"
}
]
},
{
"info": {
"name": "rules-configs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve Config Variable Keys for Rules (get_rules-configs)",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/rules-configs",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve rules config variable keys.\n\n Note: For security, config variable values cannot be retrieved outside rule execution."
},
{
"info": {
"name": "Set Rules Config for a Given Key",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/rules-configs/:key",
"params": [
{
"name": "key",
"value": "",
"type": "path",
"description": "Key of the rules config variable to set (max length: 127 characters)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Sets a rules config variable."
},
{
"info": {
"name": "Delete Rules Config for a Given Key",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/rules-configs/:key",
"params": [
{
"name": "key",
"value": "",
"type": "path",
"description": "Key of the rules config variable to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a rules config variable identified by its key."
}
]
},
{
"info": {
"name": "self-service-profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Self-service Profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/self-service-profiles",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves self-service profiles.\n"
},
{
"info": {
"name": "Create a Self-service Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/self-service-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates a self-service profile.\n"
},
{
"info": {
"name": "Get a Self-service Profile by Id",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/self-service-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the self-service profile to retrieve"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a self-service profile by Id."
},
{
"info": {
"name": "Update a Self-service Profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/self-service-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the self-service profile to update"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates a self-service profile."
},
{
"info": {
"name": "Delete a Self-service Profile by Id",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/self-service-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the self-service profile to delete"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a self-service profile by Id."
},
{
"info": {
"name": "Get Custom Text for a Self-service Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/self-service-profiles/:id/custom-text/:language/:page",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the self-service profile."
},
{
"name": "language",
"value": "",
"type": "path",
"description": "The language of the custom text."
},
{
"name": "page",
"value": "",
"type": "path",
"description": "The page where the custom text is shown."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.\n"
},
{
"info": {
"name": "Set Custom Text for a Self-service Profile",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/self-service-profiles/:id/custom-text/:language/:page",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the self-service profile."
},
{
"name": "language",
"value": "",
"type": "path",
"description": "The language of the custom text."
},
{
"name": "page",
"value": "",
"type": "path",
"description": "The page where the custom text is shown."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Updates text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.\n"
},
{
"info": {
"name": "Create an Access Ticket to Initiate the Self-Service Enterprise Configuration Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/self-service-profiles/:id/sso-ticket",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the self-service profile to retrieve"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Creates an access ticket to initiate the Self-Service Enterprise Configuration flow using a self-service profile.\n"
},
{
"info": {
"name": "Revoke a Self-Service Enterprise Configuration Access Ticket",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/self-service-profiles/:profileId/sso-ticket/:id/revoke",
"params": [
{
"name": "profileId",
"value": "",
"type": "path",
"description": "The id of the self-service profile"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the ticket to revoke"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revokes a Self-Service Enterprise Configuration access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service Enterprise Configuration session. If any users have already started a session through this ticket, their session will be terminated. Clients should expect a `202 Accepted` response upon successful processing, indicating that the request has been acknowledged and that the revocation is underway but may not be fully completed at the tim"
}
]
},
{
"info": {
"name": "sessions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Session",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/sessions/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of session to retrieve"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve session information."
},
{
"info": {
"name": "Update Session",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/sessions/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the session to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update session information."
},
{
"info": {
"name": "Delete Session",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/sessions/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the session to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a session by ID."
},
{
"info": {
"name": "Revokes a Session",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/sessions/:id/revoke",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the session to revoke."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revokes a session by ID and all associated refresh tokens."
}
]
},
{
"info": {
"name": "stats",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Active Users Count",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/stats/active-users",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the number of active users that logged in during the last 30 days."
},
{
"info": {
"name": "Get Daily Stats",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/stats/daily",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional first day of the date range (inclusive) in YYYYMMDD format."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "Optional last day of the date range (inclusive) in YYYYMMDD format."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the number of logins, signups and breached-password detections (subscription required) that occurred each day within a specified date range."
}
]
},
{
"info": {
"name": "supplemental-signals",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get the Supplemental Signals Configuration for a Tenant",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/supplemental-signals",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the supplemental signals configuration for a tenant."
},
{
"info": {
"name": "Update the Supplemental Signals Configuration for a Tenant",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/supplemental-signals",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the supplemental signals configuration for a tenant."
}
]
},
{
"info": {
"name": "tenants",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Tenant Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/tenants/settings",
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve tenant settings. A list of fields to include or exclude may also be specified."
},
{
"info": {
"name": "Update Tenant Settings",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/tenants/settings",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update settings for a tenant."
}
]
},
{
"info": {
"name": "tickets",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create an Email Verification Ticket",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/tickets/email-verification",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create an email verification ticket for a given user. An email verification ticket is a generated URL that the user can consume to verify their email address.\n"
},
{
"info": {
"name": "Create a Password Change Ticket",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/tickets/password-change",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a password change ticket for a given user. A password change ticket is a generated URL that the user can consume to start a reset password flow.\n\nNote: This endpoint does not verify the given user’s identity. If you call this endpoint within your application, you must design your application to verify the user’s identity.\n"
}
]
},
{
"info": {
"name": "token-exchange-profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Token Exchange Profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/token-exchange-profiles",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of all Token Exchange Profiles available in your tenant.\n\nBy using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.\n\nThis endpoint supports Checkpoint pagination. To search by checkpoint, use the following paramet"
},
{
"info": {
"name": "Create a Token Exchange Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/token-exchange-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new Token Exchange Profile within your tenant.\n\nBy using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.\n"
},
{
"info": {
"name": "Get a Token Exchange Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/token-exchange-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the Token Exchange Profile to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a single Token Exchange Profile specified by ID.\n\nBy using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.\n"
},
{
"info": {
"name": "Update an Existing Token Exchange Profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/token-exchange-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the Token Exchange Profile to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a Token Exchange Profile within your tenant.\n\nBy using this feature, you agree to the applicable Free Trial terms in Okta's Master Subscription Agreement. It is your responsibility to securely validate the user's subject_token. See User Guide for more details.\n\n"
},
{
"info": {
"name": "Delete a Token Exchange Profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/token-exchange-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the Token Exchange Profile to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a Token Exchange Profile within your tenant.\n\nBy using this feature, you agree to the applicable Free Trial terms in Okta's Master Subscription Agreement. It is your responsibility to securely validate the user's subject_token. See User Guide for more details.\n\n"
}
]
},
{
"info": {
"name": "user-attribute-profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get User Attribute Profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/user-attribute-profiles",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 5."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination.\n"
},
{
"info": {
"name": "Post User Attribute Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/user-attribute-profiles",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a User Attribute Profile"
},
{
"info": {
"name": "Get User Attribute Profile Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/user-attribute-profiles/templates",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a list of User Attribute Profile Templates.\n"
},
{
"info": {
"name": "Get User Attribute Profile Template",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/user-attribute-profiles/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user-attribute-profile-template to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve a User Attribute Profile Template.\n"
},
{
"info": {
"name": "Get User Attribute Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/user-attribute-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user-attribute-profile to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details about a single User Attribute Profile specified by ID. "
},
{
"info": {
"name": "Modify a User Attribute Profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/user-attribute-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user attribute profile to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update the details of a specific User attribute profile, such as name, user_id and user_attributes.\n"
},
{
"info": {
"name": "Delete User Attribute Profile",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/user-attribute-profiles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user-attribute-profile to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a single User Attribute Profile specified by ID.\n"
}
]
},
{
"info": {
"name": "user-blocks",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Blocks by Identifier",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/user-blocks",
"params": [
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Should be any of a username, phone number, or email."
},
{
"name": "consider_brute_force_enablement",
"value": "",
"type": "query",
"description": "\n If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses.\n If true and Brute Force Protection is disabled, will return an empty list.\n "
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email)."
},
{
"info": {
"name": "Unblock by Identifier",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/user-blocks",
"params": [
{
"name": "identifier",
"value": "",
"type": "query",
"description": "Should be any of a username, phone number, or email."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).\n\nNote: This endpoint does not unblock users that were blocked by a tenant administrator.\n"
},
{
"info": {
"name": "Get a User's Blocks",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/user-blocks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "user_id of the user blocks to retrieve."
},
{
"name": "consider_brute_force_enablement",
"value": "",
"type": "query",
"description": "\n If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses.\n If true and Brute Force Protection is disabled, will return an empty list.\n "
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of all Brute-force Protection blocks for the user with the given ID.\n"
},
{
"info": {
"name": "Unblock a User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/user-blocks/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The user_id of the user to update."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove all Brute-force Protection blocks for the user with the given ID.\n\nNote: This endpoint does not unblock users that were blocked by a tenant administrator.\n"
}
]
},
{
"info": {
"name": "users",
"type": "folder"
},
"items": [
{
"info": {
"name": "List or Search Users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1"
},
{
"name": "connection",
"value": "",
"type": "query",
"description": "Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:\"connection_name\""
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Query in Lucene query string syntax. Some query types cannot be used on metadata fields, for details see Searchable Fields."
},
{
"name": "search_engine",
"value": "",
"type": "query",
"description": "The version of the search engine"
},
{
"name": "primary_order",
"value": "",
"type": "query",
"description": "If true (default), results are returned in a deterministic order. If false, results may be returned in a non-deterministic order, which can enhance performance for complex queries targeting a small number of users. Set to false only when consistent ordering and pagination is not required."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details of users. It is possible to:\n\n- Specify a search criteria for users\n- Sort the users to be returned\n- Select the fields to be returned\n- Specify the number of users to retrieve per page and the page index\n \nThe q query parameter can be used to get users that match the specified criteria using query string syntax.\n\nLearn more"
},
{
"info": {
"name": "Create a User",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/users",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a new user for a given database or passwordless connection.\n\nNote: connection is required but other parameters such as email and password are dependent upon the type of connection."
},
{
"info": {
"name": "Get a User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to retrieve."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve user details. A list of fields to include or exclude may also be specified. For more information, see Retrieve Users with the Get Users Endpoint.\n"
},
{
"info": {
"name": "Update a User",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a user.\n\nThese are the attributes that can be updated at the root level:\n\n\n - app_metadata
\n - blocked
\n - email
\n - email_verified
\n - family_name
\n - given_name
\n - name
\n - nickname
\n - password
\n - phone_number
\n - phone_verified
\n - picture
\n - username
\n - user_metadata
\n - verify_email
\n
\n\nSome considerations:\n\n - The properties of "
},
{
"info": {
"name": "Delete a User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a user by user ID. This action cannot be undone. For Auth0 Dashboard instructions, see Delete Users.\n"
},
{
"info": {
"name": "Get a List of Authentication Methods",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/authentication-methods",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the user in question."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0. Default is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Default is 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve detailed list of authentication methods associated with a specified user."
},
{
"info": {
"name": "Creates an Authentication Method for a Given User",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/users/:id/authentication-methods",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the user to whom the new authentication method will be assigned."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create an authentication method. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed."
},
{
"info": {
"name": "Update All Authentication Methods by Replacing Them with the Given Ones",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://{tenantDomain}/api/v2/users/:id/authentication-methods",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the user in question."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Replace the specified user authentication methods with supplied values.\n\n Note: Authentication methods supplied through this action do not iterate on existing methods. Instead, any methods passed will overwrite the user’s existing settings."
},
{
"info": {
"name": "Delete All Authentication Methods for the Given User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:id/authentication-methods",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the user in question."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action cannot be undone. "
},
{
"info": {
"name": "Get an Authentication Method by ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/authentication-methods/:authentication_method_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the user in question."
},
{
"name": "authentication_method_id",
"value": "",
"type": "path",
"description": "The ID of the authentication methods in question."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get an Authentication Method by ID"
},
{
"info": {
"name": "Update an Authentication Method",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/users/:id/authentication-methods/:authentication_method_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the user in question."
},
{
"name": "authentication_method_id",
"value": "",
"type": "path",
"description": "The ID of the authentication method to update."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Modify the authentication method with the given ID from the specified user. For more information, review Manage Authentication Methods with Management API."
},
{
"info": {
"name": "Delete an Authentication Method by ID",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:id/authentication-methods/:authentication_method_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the user in question."
},
{
"name": "authentication_method_id",
"value": "",
"type": "path",
"description": "The ID of the authentication method to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove the authentication method with the given ID from the specified user. For more information, review Manage Authentication Methods with Management API."
},
{
"info": {
"name": "Delete All Authenticators",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:id/authenticators",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to delete."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove all authenticators registered to a given user ID, such as OTP, email, phone, and push-notification. This action cannot be undone. For more information, review Manage Authentication Methods with Management API."
},
{
"info": {
"name": "Get a User's Connected Accounts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/connected-accounts",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to list connected accounts for."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results to return. Defaults to 10 with a maximum of 20"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve all connected accounts associated with the user."
},
{
"info": {
"name": "Get the First Confirmed Multi-factor Authentication (MFA) Enrollment",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/enrollments",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to list enrollments for."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the first multi-factor authentication enrollment that a specific user has confirmed."
},
{
"info": {
"name": "Get Tokensets for a User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/federated-connections-tokensets",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "User identifier"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List active federated connections tokensets for a provided user"
},
{
"info": {
"name": "Deletes a Tokenset for Federated Connections by Id.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:id/federated-connections-tokensets/:tokenset_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of the user that owns the tokenset"
},
{
"name": "tokenset_id",
"value": "",
"type": "path",
"description": "The tokenset id"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Deletes a Tokenset for Federated Connections by Id."
},
{
"info": {
"name": "Get User's Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/groups",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to list groups for."
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields"
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List all groups to which this user belongs.\n"
},
{
"info": {
"name": "Link a User Account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/users/:id/identities",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the primary user account to link a second user account to."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Link two user accounts together forming a primary and secondary relationship. On successful linking, the endpoint returns the new array of the primary account identities.\n\nNote: There are two ways of invoking the endpoint:\n\n
\n - With the authenticated primary account's JWT in the Authorization header, which has the
update:current_user_identities scope:\n \n POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities\n Authorization: \"Bearer PRIMARY_ACCOUNT_JWT\"\n "
},
{
"info": {
"name": "Unlink a User Identity",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:id/identities/:provider/:user_id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the primary user account."
},
{
"name": "provider",
"value": "",
"type": "path",
"description": "Identity provider name of the secondary linked account (e.g. `google-oauth2`)."
},
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the secondary linked account (e.g. `123456789081523216417` part after the `|` in `google-oauth2|123456789081523216417`)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Unlink a specific secondary account from a target user. This action requires the ID of both the target user and the secondary account. \n\nUnlinking the secondary account removes it from the identities array of the target user and creates a new standalone profile for the secondary account. To learn more, review Unlink User Accounts.\n"
},
{
"info": {
"name": "Get User's Log Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/logs",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user of the logs to retrieve"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Paging is disabled if parameter not sent."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to sort by. Use `fieldname:1` for ascending order and `fieldname:-1` for descending."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve log events for a specific user.\n\nNote: For more information on all possible event types, their respective acronyms and descriptions, see Log Event Type Codes.\n\nFor more information on the list of fields that can be used in `sort`, see Searchable Fields.\n\nAuth0 authentication factors for a user."
},
{
"info": {
"name": "Delete a User's Multi-factor Provider",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:id/multifactor/:provider",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to remove a multifactor configuration from."
},
{
"name": "provider",
"value": "",
"type": "path",
"description": "The multi-factor provider. Supported values 'duo' or 'google-authenticator'"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove a multifactor authentication configuration from a user's account. This forces the user to manually reconfigure the multi-factor provider."
},
{
"info": {
"name": "List User's Organizations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/organizations",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to retrieve the organizations for."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve list of the specified user's current Organization memberships. User must be specified by user ID. For more information, review Auth0 Organizations.\n"
},
{
"info": {
"name": "Get a User's Permissions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to retrieve the permissions for."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve all permissions associated with the user."
},
{
"info": {
"name": "Assign Permissions to a User",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/users/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to assign permissions to."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign permissions to a user."
},
{
"info": {
"name": "Remove Permissions from a User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to remove permissions from."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove permissions from a user.\n"
},
{
"info": {
"name": "Generate New Multi-factor Authentication (MFA) Recovery Code",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/users/:id/recovery-code-regeneration",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to regenerate a multi-factor authentication recovery code for."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Remove an existing multi-factor authentication (MFA) recovery code and generate a new one. If a user cannot access the original device or account used for MFA enrollment, they can use a recovery code to authenticate. "
},
{
"info": {
"name": "Revokes Selected Resources from a User",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/users/:id/revoke-access",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Revokes selected resources related to a user (sessions, refresh tokens, ...)."
},
{
"info": {
"name": "Clear Risk Assessment Assessors for a Specific User",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/users/:id/risk-assessments/clear",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to clear assessors for."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Clear risk assessment assessors for a specific user"
},
{
"info": {
"name": "Get a User's Roles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to list roles for."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Number of results per page."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve detailed list of all user roles currently assigned to a user.\n\nNote: This action retrieves all roles assigned to a user in the context of your whole tenant. To retrieve Organization-specific roles, use the following endpoint: Get user roles assigned to an Organization member.\n"
},
{
"info": {
"name": "Assign Roles to a User",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/users/:id/roles",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the user to associate roles with."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Assign one or more existing user roles to a user. For more information, review Role-Based Access Control.\n\nNote: New roles cannot be created through this action. Additionally, this action is used to assign roles to a user in the context of your whole tenant. To assign roles in the context of a specific Organization, use the following endpoint: Note: This action removes a role from a user in the context of your whole tenant. If you want to unassign a role from a user in the context of a specific Organization, use the following endpoint: Delete user roles from an Organization member.\n"
},
{
"info": {
"name": "Get Refresh Tokens for a User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:user_id/refresh-tokens",
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to get refresh tokens for"
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "An optional cursor from which to start the selection (exclusive)."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details for a user's refresh tokens."
},
{
"info": {
"name": "Delete Refresh Tokens for a User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:user_id/refresh-tokens",
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to get remove refresh tokens for"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete all refresh tokens for a user."
},
{
"info": {
"name": "Get Sessions for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users/:user_id/sessions",
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to get sessions for"
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results inside an object that contains the total result count (true) or as a direct array of results (false, default)."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "An optional cursor from which to start the selection (exclusive)."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve details for a user's sessions."
},
{
"info": {
"name": "Delete Sessions for User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/users/:user_id/sessions",
"params": [
{
"name": "user_id",
"value": "",
"type": "path",
"description": "ID of the user to get sessions for"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete all sessions for a user."
}
]
},
{
"info": {
"name": "users-by-email",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search Users by Email",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/users-by-email",
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false). Defaults to true."
},
{
"name": "email",
"value": "",
"type": "query",
"description": "Email address to search for (case-sensitive)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it. \n\nFor example, if you register a user as JohnSmith@example.com, Auth0 saves the user's email as johnsmith@example.com. \n\nTherefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.\n"
}
]
},
{
"info": {
"name": "verifiable-credentials",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Verifiable Credential Templates for a Tenant.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates",
"params": [
{
"name": "from",
"value": "",
"type": "query",
"description": "Optional Id from which to start selection."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of results per page. Defaults to 50."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "List verifiable credential templates."
},
{
"info": {
"name": "Create a Verifiable Credential Template.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Create a verifiable credential template."
},
{
"info": {
"name": "Get a Verifiable Credential Template by ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the template to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get a verifiable credential template."
},
{
"info": {
"name": "Update a Verifiable Credential Template by ID.",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the template to retrieve."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Update a verifiable credential template."
},
{
"info": {
"name": "Delete a Verifiable Credential Template by ID.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of the template to retrieve."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Delete a verifiable credential template."
}
]
}
],
"bundled": true
}