14.1.1.7. Default Realm endpoints

These endpoints are used to define the default realm, retrieve it and delete it.

DELETE /defaultrealm

This call deletes the default realm.

Return

a json result with either 1 (success) or 0 (fail)

Example response:

 {
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "status": true,
    "value": 1
  },
  "version": "privacyIDEA unknown"
}
GET /defaultrealm

This call returns the default realm

Return

a json description of the default realm with the resolvers

Example response:

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "status": true,
    "value": {
      "defrealm": {
        "default": true,
        "resolver": [
          {
            "name": "defresolver",
            "type": "passwdresolver"
          }
        ]
      }
    }
  },
  "version": "privacyIDEA unknown"
}
POST /defaultrealm/(realm)

This call sets the default realm.

Parameters
  • realm – the name of the realm, that should be the default realm

Return

a json result with either 1 (success) or 0 (fail)