> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/reference/api-reference/auth-server-api.md).

# Auth-Server API

{% file src="/files/2wVIvlk234bbuFNt80oG" %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/auth/ldap" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/auth/mfa" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/auth/msEntraId" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/listUsers" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/usernames" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/ids" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/batch" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/batch/delete" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/change-password" method="put" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}" method="put" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}" method="delete" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}/tokens" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}/tokens" method="delete" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}/certificates" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}/certificates" method="delete" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}/roles" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/users/{id}/roles" method="delete" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/page" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/names" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/{id}" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/{id}" method="put" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/{id}" method="delete" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/{id}/permissions" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/{id}/permissions" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/{id}/permissions/{pemId}" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/{id}/permissions/{pemId}" method="put" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/roles/{id}/permissions/{pemId}" method="delete" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/login" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/session" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/permissions" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/permissions/page" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/permissions/ids" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/logout" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/client-registry/register" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/client-registry" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/client-registry/status" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/client-registry/open" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/client-registry/lock" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/client-registry/confirm" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/client-registry/runners/{id}" method="delete" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/certificates" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/certificates" method="delete" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/certificates" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/certificates/content" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/broker/auth/enhanced" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/policy/password" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/policy/username" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/maintenance/db" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/maintenance/db/backup" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/maintenance/db/backup" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/maintenance/db/restore" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/mfa/enable" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/mfa/validate" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/mfa/login" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/mfa/disable" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/mfa/regenerate/backupcodes" method="post" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/mfa/isenrolled" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/msEntraId/login" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}

{% openapi src="/files/2wVIvlk234bbuFNt80oG" path="/msEntraId/redirect" method="get" %}
[auth-server-schema.yaml](https://1013835843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoyZiJ8xxPK7WHUGsGYNs%2Fuploads%2Fgit-blob-f9777671b09338df54d4fd91751eb6092747198e%2Fauth-server-schema.yaml?alt=media)
{% endopenapi %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cybus.io/reference/api-reference/auth-server-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.