This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.

Management API

Every answer is checked against the model shown here before it is sent, and no answer carries a member its model does not list. A member shown as any JSON is one whose shape belongs to somebody else, and says whose. .{key} is a key that is data, and [] an element of a list.

A refusal

Unless an operation below says otherwise, any status it does not list answers this:

Member Type Required What it is
error string    
error_description string    
errors list    
errors[] string    
message string    
ok boolean    
status integer    
why string    

GET /admin-api/kerberos

getKerberosSettings

The KDC’s own settings

The krb5.* settings: the realm, the two raw ports, the clock skew and the deliberate clock OFFSET, the one password every user account shares, the names that stay unknown, the long-term keys behind krbtgt, s2kparams, and the two that decide whether a ticket presented at /authn/spnego may start a browser session.

MOST OF THEM ARE RESTART-ONLY, and one fact is why: the principal database — every long-term key in it — is built from these when the process starts, so a realm or a password changed at runtime would leave every existing ticket undecryptable by the service that issued it.

TWO OF THEM EXIST TO MAKE FAILURES REACHABLE. krb5.unknownUsers names the only principals that can produce KDC_ERR_C_PRINCIPAL_UNKNOWN — every other name gets an account — and krb5.clockOffset moves this KDC’s idea of now so a client can be shown KRB_AP_ERR_SKEW without anybody touching a system clock.

AND A status MEMBER (#173): what the KDC does about pre-authentication in this realm — whether a password alone gets a ticket for a person who holds or must hold a second factor (passwordAloneRefused; product refuses it with KDC_ERR_POLICY after the password verified), whether RFC 6113 FAST is served (fast, with its armor types and factors), and the RFC 8129 indicator an OTP pre-authentication puts in a ticket (otpIndicator).

THERE IS NO POST BESIDE THIS ONE and that is not a gap: every form on the console page this mirrors posts set-many to /admin/config, so POST /admin-api/config/set-many is already the operation for it. One store, one action, two doors.

Mirrors GET /admin/kerberos on the admin console.

The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).

Scope: admin:read.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: What the page says, and the settings it draws — described rows carrying each value’s source and whether it can be changed while the service runs.

Member Type Required What it is
alsoHtml list    
alsoHtml[] string    
leadHtml string    
links list    
links[].href string    
links[].what string    
notes list    
notes[] string    
page string    
protocolEndpoints list    
protocolEndpoints[].listening boolean    
protocolEndpoints[].methods list, or string    
protocolEndpoints[].methods[] string    
protocolEndpoints[].name string    
protocolEndpoints[].registered boolean    
protocolEndpoints[].route string    
protocolEndpoints[].transport string    
protocolEndpoints[].url string    
settings object    
settings.context object    
settings.context.configFile string, or null    
settings.context.defaultsFile string, or null    
settings.context.inRealm boolean    
settings.context.persistenceMode string    
settings.context.persistsAppconfig boolean    
settings.context.persistsRealms boolean    
settings.context.realmId string, or null    
settings.editableCount integer    
settings.groups list    
settings.groups[].group string    
settings.groups[].settings list    
settings.groups[].settings[].appconfigPath string    
settings.groups[].settings[].csvValueNotes map   The sentence beside each value.
settings.groups[].settings[].csvValueNotes.{key} string    
settings.groups[].settings[].csvValues list    
settings.groups[].settings[].csvValues[] string    
settings.groups[].settings[].default list, or boolean, or number, or string, or null    
settings.groups[].settings[].default[] string    
settings.groups[].settings[].description string    
settings.groups[].settings[].editRefusal string    
settings.groups[].settings[].editable boolean    
settings.groups[].settings[].enumValues list    
settings.groups[].settings[].enumValues[] string    
settings.groups[].settings[].env string, or null    
settings.groups[].settings[].group string    
settings.groups[].settings[].key string    
settings.groups[].settings[].label string    
settings.groups[].settings[].legacyEnv string, or null    
settings.groups[].settings[].masked boolean    
settings.groups[].settings[].max number    
settings.groups[].settings[].min number    
settings.groups[].settings[].ordered boolean    
settings.groups[].settings[].overridden boolean    
settings.groups[].settings[].realmSettable boolean    
settings.groups[].settings[].restartReason string    
settings.groups[].settings[].selectAll map   The rules by kind: onlyWhileOn and aloneWhileOn.
settings.groups[].settings[].selectAll.{key} list    
settings.groups[].settings[].selectAll.{key}[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].values object   Nested deeper than this page draws.
settings.groups[].settings[].source string    
settings.groups[].settings[].step number    
settings.groups[].settings[].text string, or null    
settings.groups[].settings[].type string    
settings.groups[].settings[].value list, or boolean, or number, or string, or null    
settings.groups[].settings[].value[] string    
settings.overridden list    
settings.overridden[] string    
settings.page string    
settings.setWith string    
settings.settingCount integer    
settings.sharedWith map   The other pages, by settings group.
settings.sharedWith.{key} list    
settings.sharedWith.{key}[].label string    
settings.sharedWith.{key}[].path string    
status object    
status.armorTypes list    
status.armorTypes[] string    
status.fast boolean    
status.fastFactors list    
status.fastFactors[] string    
status.krbtgt object    
status.krbtgt.confirmWord string    
status.krbtgt.createdAt string    
status.krbtgt.etypes list    
status.krbtgt.etypes[].etype integer    
status.krbtgt.etypes[].name string, or null    
status.krbtgt.intervalDays number    
status.krbtgt.invalidatedAt string    
status.krbtgt.jobs object    
status.krbtgt.jobs.byHand string    
status.krbtgt.jobs.scheduled string    
status.krbtgt.keyCreatedAt string    
status.krbtgt.kvno number, or null    
status.krbtgt.lastRotatedAt string, or null    
status.krbtgt.nextDueAt string, or null    
status.krbtgt.offReason string    
status.krbtgt.principal string    
status.krbtgt.retained list    
status.krbtgt.retained[].etypes list    
status.krbtgt.retained[].etypes[].etype integer    
status.krbtgt.retained[].etypes[].name string, or null    
status.krbtgt.retained[].expiresAt string    
status.krbtgt.retained[].kvno number    
status.krbtgt.retained[].retiredAt string    
status.krbtgt.retainedTtlSeconds number    
status.krbtgt.rotatedAt string    
status.krbtgt.scheduled boolean    
status.krbtgt.sealed boolean    
status.krbtgt.source string    
status.krbtgt.trustRealm string    
status.krbtgt.why string    
status.krbtgt.windowOpenUntil string    
status.notImplemented list    
status.notImplemented[] string    
status.note string    
status.otpIndicator string    
status.passwordAloneForSecondFactorAccounts string    
status.passwordAloneRefused boolean    
status.pkinit object    
status.pkinit.anonymousPkinit boolean    
status.pkinit.anonymousTickets string    
status.pkinit.clientCertificates string    
status.pkinit.cmsDigests list    
status.pkinit.cmsDigests[] string    
status.pkinit.freshnessRequired boolean    
status.pkinit.indicators list    
status.pkinit.indicators[] string    
status.pkinit.kdcCertificate object    
status.pkinit.kdcCertificate.keyAlg string    
status.pkinit.kdcCertificate.notAfter string    
status.pkinit.kdcCertificate.serialHex string    
status.pkinit.kdcKeyAlgorithm string    
status.pkinit.kdfs list    
status.pkinit.kdfs[] string    
status.pkinit.keyAgreement list    
status.pkinit.keyAgreement[] string    
status.pkinit.legacyKdf boolean    
status.pkinit.pkinit boolean    
status.pkinit.postQuantum string    
status.pkinit.rsaKeyTransport string    
status.refusal string, or null    
title string    
what string    

GET /admin-api/kerberos/claims

getKerberosPacClaims

The claims a Kerberos ticket’s PAC carries

The kerberos-pac claim set — the claims this realm’s KDC writes into PAC_CLIENT_CLAIMS_INFO ([MS-PAC] 2.11) while krb5.pacClaims is on — with each row’s claim id, the four PAC claim types and the claims one person’s next TGT would carry, built by the function the KDC calls.

A TGT carries this set, with the person’s realm-wide roles under it as a string claim. A service ticket carries what its TGT carried, with the rows of the application whose krb5ServicePrincipalName names the service added and winning by name (that application’s Configuration tab, krb5ClaimsPac). A claim id is ad://ext/<name>:<hex>, the hex derived from the name (idFormat). Nothing already issued changes.

The set’s TICKED CATALOGUE (#498) is the other pages’ attributeCatalogue (each row with the pacClaimId it becomes) and sets[].attributes: a ticked attribute is a string claim of every value on the person’s entry, under the rows and the roles claim, which win by claim id. preview.byLdap is what each attribute would carry for the person.

Mirrors GET /admin/kerberos on the admin console.

The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).

Scope: admin:read.

Parameters

Name In Type Required What it is
user query string   Whose claims to preview: preview.claims is what their next TGT would carry.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: The PAC set, its claim ids, the setting and the preview.

Member Type Required What it is
attributeCatalogue list    
attributeCatalogue[].claim string    
attributeCatalogue[].custom boolean    
attributeCatalogue[].generated boolean    
attributeCatalogue[].label string, or null    
attributeCatalogue[].ldap string    
attributeCatalogue[].pacClaimId string    
attributeCatalogue[].schema string, or null    
attributeCatalogue[].sets map   Whether it is ticked, by claim set.
attributeCatalogue[].sets.{key} boolean    
attributeCatalogue[].syntax string, or null    
attributeChoices list    
attributeChoices[].attribute string    
attributeChoices[].from list    
attributeChoices[].from[] string    
enabled boolean    
idFormat string    
placeholders list    
placeholders[] string    
precedence string    
preview object    
preview.byLdap map   By directory attribute.
preview.byLdap.{key}.claim string    
preview.byLdap.{key}.claimId string    
preview.byLdap.{key}.ldap string    
preview.byLdap.{key}.ldpTerm string, or null    
preview.byLdap.{key}.source string    
preview.byLdap.{key}.value any JSON   A claim value as it would be issued. Its JSON type is the catalogue row’s and the person’s own data, and a row may nest under a dotted path. A claim value as it would be issued. Its JSON type is the catalogue row’s and the person’s own data, and a row may nest under a dotted path.
preview.byLdap.{key}.values list    
preview.byLdap.{key}.values[] any JSON   A claim value as it would be issued. Its JSON type is the catalogue row’s and the person’s own data, and a row may nest under a dotted path. A claim value as it would be issued. Its JSON type is the catalogue row’s and the person’s own data, and a row may nest under a dotted path.
preview.claims list    
preview.claims[].dropped boolean    
preview.claims[].from string    
preview.claims[].id string    
preview.claims[].name string    
preview.claims[].type string    
preview.claims[].values list    
preview.claims[].values[] any JSON   A claim value as it would be issued. Its JSON type is the catalogue row’s and the person’s own data, and a row may nest under a dotted path. A claim value as it would be issued. Its JSON type is the catalogue row’s and the person’s own data, and a row may nest under a dotted path.
preview.entryFound boolean    
preview.user string    
protocolEndpoints list    
protocolEndpoints[].listening boolean    
protocolEndpoints[].methods list, or string    
protocolEndpoints[].methods[] string    
protocolEndpoints[].name string    
protocolEndpoints[].registered boolean    
protocolEndpoints[].route string    
protocolEndpoints[].transport string    
protocolEndpoints[].url string    
sets list    
sets[].attributes list    
sets[].attributes[] string    
sets[].claims list    
sets[].claims[].attribute string    
sets[].claims[].claimId string    
sets[].claims[].multi boolean    
sets[].claims[].name string    
sets[].claims[].nameFormat string    
sets[].claims[].namespace string    
sets[].claims[].type string    
sets[].claims[].value string    
sets[].id string    
sets[].label string    
setting string    
types list    
types[] string    

POST /admin-api/kerberos/claims/add

addKerberosPacClaim

Add one claim to one set

Every ticket of that kind issued from now on carries it; nothing already issued changes.

ADDITIVE ONLY. What the protocol puts in is never displaced — an ID Token’s sub, a SAML 2.0 assertion’s name, a WS-Federation assertion’s whole identity claim list. There is NO reserved list here: those names are load-bearing in a JWT, and an assertion attribute called exp collides with nothing. An entry with no name, and two entries of one name, are still refused.

Mirrors POST /admin/kerberos#kerberos-tab-claims on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
name string yes  
nameFormat string   The SAML 2.0 set only.
namespace string   The SAML 1.1 set only. Defaults to the WS-Federation claim namespace, which is what every relying party already reads.
set one of kerberos-pac yes  
type one of string, int64, uint64, boolean   The Kerberos PAC set only (#493): the PAC claim type. Defaults to string; ignored by the other sets.
value string   May carry a ${…} placeholder.

200: The set as it now stands, in claims.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

POST /admin-api/kerberos/claims/add-attribute-claim

addKerberosPacAttributeClaim

Add one claim carrying a directory attribute

The claim’s value is attribute on the entry of the person the ticket is about (#94) — any attribute, where the directory-attribute half of a set offers only the fixed catalogue, under the name given here. Only the directory, never an invented value: a person whose entry lacks it gets no such claim, and a lower layer of the same name still answers. multi carries every value. A secret, a binary value or an attribute this service keeps (sts, hoba, app, pwd) is refused. Removed by remove, by name. The same reserved names are refused as for add, and a directory write that moves the attribute sends CAEP token-claims-change to holders of live tokens.

Mirrors POST /admin/kerberos#kerberos-tab-claims on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
attribute string yes The directory attribute.
multi boolean   Every value rather than the first.
name string yes  
nameFormat string   The SAML 2.0 set only.
namespace string   The SAML 1.1 set only.
set one of kerberos-pac yes  
type one of string, int64, uint64, boolean   The PAC claim type each value becomes; a value that is not one leaves the claim out of the ticket.

200: The set as it now stands, in claims.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

POST /admin-api/kerberos/claims/attributes

setKerberosPacClaimAttributes

Set which LDAP attributes one set carries

The array REPLACES the selection for that set. An attribute not in the array is removed, which is how removal is expressed — there is no per-attribute remove, because the console’s control is a table of checkboxes and an API that removed differently would be a second model of the same state.

A selected attribute becomes a STRING PAC claim named ad://ext/<attribute>:<hex>, carrying EVERY value on that person’s entry under ou=users; an entry without it carries no claim — nothing is invented (#498). Unlike POST /admin-api/credential-claims/select this does NOT sweep the directory: the credential page writes the attributes it needs onto every entry, and doing it from here as well would mean two pages racing to populate one directory. Selecting an attribute nobody has an entry value for still produces a claim; it is generated, and attributeReport says so per claim.

An unknown attribute name refuses the WHOLE call rather than being skipped: the catalogue is fixed, so an unknown name is either a hand-written request that deserves an answer or a rename that left a caller behind. attributeCatalogue in the GET beside this is the list — and it is ONE catalogue for all four sets, so either GET answers it in full.

A TYPED claim of the same name WINS over one of these, and THE PROTOCOL’S OWN beats both — which is worth knowing before it is discovered on the wire. An ID Token always carries name, given_name, family_name, preferred_username and email built from the sign-in, so selecting cn, givenName, sn, uid or mail ON THAT SET changes nothing the client sees; the same five reach an access token from the directory, because the protocol sets none of them there. A SAML 2.0 assertion sets name the same way and a WS-Federation one sets the whole identity claim list. Both halves are reported by that same GET.

Mirrors POST /admin/kerberos#kerberos-tab-claims on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
attributes list yes LDAP attribute type names, from attributeCatalogue. An EMPTY array clears the selection — and so does an ABSENT one, so a misspelt field name empties the set rather than being refused. The reply names everything it removed and the audit log keeps a row saying the same, and attributes-clear is how a caller that means it says so.
attributes[] string    
set one of kerberos-pac yes  

200: What the set carries now, in attributes, with added and removed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

POST /admin-api/kerberos/claims/attributes-all

selectAllKerberosPacClaimAttributes

Put every catalogued attribute in one set

Every attribute type in the catalogue, which is a legitimate thing to test and makes a large ticket. It exists as its own operation so that “all of them” does not mean a caller constructing the whole list of names that has to be updated whenever the catalogue is.

Mirrors POST /admin/kerberos#kerberos-tab-claims on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
set one of kerberos-pac yes  

200: The whole catalogue, in attributes.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

POST /admin-api/kerberos/claims/attributes-clear

clearKerberosPacClaimAttributes

Take every directory attribute out of one set

The TYPED claims on that set are untouched — this is the other half. Clearing both takes this and clear.

Nothing is deleted from the directory: what was written onto an entry stays there, because an operator may have set it and nothing here has the standing to remove it.

Mirrors POST /admin/kerberos#kerberos-tab-claims on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
set one of kerberos-pac yes  

200: An empty attributes, and what was removed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

POST /admin-api/kerberos/claims/clear

clearKerberosPacClaims

Empty one set

Those tickets then carry only what the protocol puts in them.

Mirrors POST /admin/kerberos#kerberos-tab-claims on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
set one of kerberos-pac yes  

200: An empty claims.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

POST /admin-api/kerberos/claims/remove

removeKerberosPacClaim

Remove one claim from one set

By name. A name the set does not carry is refused rather than treated as already done, because the two are different facts and a caller that misspelt a name would otherwise be told it succeeded.

Mirrors POST /admin/kerberos#kerberos-tab-claims on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
name string yes  
set one of kerberos-pac yes  

200: The set as it now stands, in claims.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

POST /admin-api/kerberos/claims/replace

replaceKerberosPacClaims

Set a whole claim set at once

The array replaces whatever the set held. An EMPTY array is a legitimate call and clears it. Every entry is checked by the same rules add applies, and a single bad entry refuses the whole call — a partial replace would leave the set in a state nobody asked for.

Mirrors POST /admin/kerberos#kerberos-tab-claims on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
claims list yes  
claims[] object   One custom claim. nameFormat applies to the SAML 2.0 set and namespace to the SAML 1.1 set; both are ignored by the two JWT sets.
claims[].attribute string   AN ATTRIBUTE CLAIM (#94), in place of value: the directory attribute of the person the artifact is about that the claim carries. Only the directory, never an invented value; absent on the entry, the claim is absent. A secret, a binary value or an attribute this service keeps (sts, hoba, app, pwd) is refused.
claims[].multi boolean   An attribute claim: every value (a JSON array; several AttributeValues) rather than the first.
claims[].name string yes  
claims[].nameFormat string    
claims[].namespace string    
claims[].type one of string, number, boolean, json, int64, uint64   An attribute claim in a JWT or UserInfo set: the JSON type each value becomes (string, number, boolean, json). A value that is not one is left out. Ignored by the SAML sets. In the Kerberos PAC set (#493) EVERY row has one, of string, int64, uint64 and boolean — the PAC claim type.
claims[].value string   May carry a placeholder such as ${username}; GET /admin-api/claims lists the ones this service expands.
set one of kerberos-pac yes  

200: The set as it now stands, in claims.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
added list    
added[] string    
attributes list    
attributes[] string    
claims list    
claims[].attribute string    
claims[].claimId string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value string    
errors list    
errors[] string    
message string    
ok boolean yes  
removed list    
removed[] string    
set string    

GET /admin-api/kerberos/principals

getKerberosPrincipals

Who the KDC holds a stored long-term key for

Three lists, paged separately with ?peoplePage=, ?servicesPage= and ?databasePage= and one ?per=.

people — the directory people whose Kerberos keys were derived from their own password when it was set or verified (PRODUCT MODE): the principal, the kvno, the enctypes, when and on what event the keys were derived, whether they are sealed, and current — whether they still match the password the entry holds. A person whose keys are not current is refused by the KDC until their next verified sign-in derives new ones.

services — the service principals created with a RANDOM key: the principal, the kvno, the enctypes, when created and last rotated.

krbtgt (#169) — the realm’s krbtgt key: where it comes from (stored, password in development, none, unreadable), its kvno and enctypes, when it was made and last rotated, the versions kept and until when, and the schedule — scheduled, offReason, intervalDays, nextDueAt.

database (#595) — every principal the KDC holds, the development fixtures and the names created on first sight among them: the principal, its name type, salt, enctypes and kvno, and its flags, with fixtureAccounts and realmsServed beside it. What the demonstration document GET /krb5/principals listed until #595 deleted it, without its two development passwords.

NO KEY MATERIAL IS IN THIS REPLY, sealed or otherwise — both lists are built from the public info attributes. A trust realm has a KDC and a principal database of its own since 2026-09-15, so a realm prefix answers that realm’s principals.

Mirrors GET /admin/kerberos on the admin console.

The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).

Scope: admin:read.

Parameters

Name In Type Required What it is
per query integer   Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own.
peoplePage query integer   Which page of people to return, answered by peoplePaging. Directory people holding keys derived from their own password.
servicesPage query integer   Which page of services to return, answered by servicesPaging. Service principals created with a random key.
databasePage query integer   Which page of database to return, answered by databasePaging. Every principal in the KDC’s database, by its public fields.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: The three lists with their paging, whether this is a product KDC, whether krb5.personKeys is on, the enctypes and starting kvno, and the acceptor’s SPN.

Member Type Required What it is
acceptor object    
acceptor.available boolean    
acceptor.spn string, or null    
acceptor.storedKey boolean    
accountPolicy object    
accountPolicy.anyUsernameAuthenticates boolean    
accountPolicy.neverCreated list    
accountPolicy.neverCreated[] string    
accountPolicy.serviceHosts list    
accountPolicy.serviceHosts[] string    
actions list    
actions[] string    
database list    
database[].autoCreated boolean    
database[].description string    
database[].directoryKeys boolean    
database[].etypes list    
database[].etypes[].etype integer    
database[].etypes[].name string, or null    
database[].kvno number    
database[].nameType number    
database[].okAsDelegate boolean    
database[].passwordExpired boolean    
database[].principal string    
database[].requiresPreAuth boolean    
database[].revoked boolean    
database[].salt string, or null    
databasePaging object    
databasePaging.firstRow integer    
databasePaging.lastRow integer    
databasePaging.noun string, or null    
databasePaging.page integer    
databasePaging.pages integer    
databasePaging.param string, or null    
databasePaging.perPage integer    
databasePaging.total integer    
databaseTotal integer    
enctypes list    
enctypes[] integer    
fixtureAccounts boolean    
installed boolean    
kerberos object    
kerberos.active boolean    
kerberos.enabled boolean    
kerberos.kerberosRealm string, or null    
kerberos.reason string, or null    
kerberos.served list    
kerberos.served[] string    
kerberos.trustRealm string, or null    
krbtgt object    
krbtgt.confirmWord string    
krbtgt.createdAt string    
krbtgt.etypes list    
krbtgt.etypes[].etype integer    
krbtgt.etypes[].name string, or null    
krbtgt.intervalDays number    
krbtgt.invalidatedAt string    
krbtgt.jobs object    
krbtgt.jobs.byHand string    
krbtgt.jobs.scheduled string    
krbtgt.keyCreatedAt string    
krbtgt.kvno number, or null    
krbtgt.lastRotatedAt string, or null    
krbtgt.nextDueAt string, or null    
krbtgt.offReason string    
krbtgt.principal string    
krbtgt.retained list    
krbtgt.retained[].etypes list    
krbtgt.retained[].etypes[].etype integer    
krbtgt.retained[].etypes[].name string, or null    
krbtgt.retained[].expiresAt string    
krbtgt.retained[].kvno number    
krbtgt.retained[].retiredAt string    
krbtgt.retainedTtlSeconds number    
krbtgt.rotatedAt string    
krbtgt.scheduled boolean    
krbtgt.sealed boolean    
krbtgt.source string    
krbtgt.trustRealm string    
krbtgt.why string    
krbtgt.windowOpenUntil string    
notes object    
notes.keys string    
notes.mode string    
notes.previous string    
notes.realm string    
notes.window string    
people list    
people[].current boolean    
people[].derivedAt string    
people[].derivedOn string    
people[].etypes list    
people[].etypes[].etype integer    
people[].etypes[].name string, or null    
people[].kvno number, or null    
people[].principal string    
people[].retained list    
people[].retained[].etypes list    
people[].retained[].etypes[].etype integer    
people[].retained[].etypes[].name string, or null    
people[].retained[].expiresAt string    
people[].retained[].kvno number    
people[].retained[].retiredAt string    
people[].sealed boolean    
people[].username string    
peoplePaging object    
peoplePaging.firstRow integer    
peoplePaging.lastRow integer    
peoplePaging.noun string, or null    
peoplePaging.page integer    
peoplePaging.pages integer    
peoplePaging.param string, or null    
peoplePaging.perPage integer    
peoplePaging.total integer    
peopleTotal integer    
personKeys boolean    
productKdc boolean    
protocolEndpoints list    
protocolEndpoints[].listening boolean    
protocolEndpoints[].methods list, or string    
protocolEndpoints[].methods[] string    
protocolEndpoints[].name string    
protocolEndpoints[].registered boolean    
protocolEndpoints[].route string    
protocolEndpoints[].transport string    
protocolEndpoints[].url string    
realm string, or null    
realmsServed list    
realmsServed[] string    
retention object    
retention.ttlSeconds number    
retention.ttlSetting number    
retention.versions number    
services list    
services[].createdAt string    
services[].etypes list    
services[].etypes[].etype integer    
services[].etypes[].name string, or null    
services[].held boolean    
services[].kvno number, or null    
services[].principal string    
services[].retained list    
services[].retained[].etypes list    
services[].retained[].etypes[].etype integer    
services[].retained[].etypes[].name string, or null    
services[].retained[].expiresAt string    
services[].retained[].kvno number    
services[].retained[].retiredAt string    
services[].rotatedAt string    
services[].sealed boolean    
services[].spn string    
servicesPaging object    
servicesPaging.firstRow integer    
servicesPaging.lastRow integer    
servicesPaging.noun string, or null    
servicesPaging.page integer    
servicesPaging.pages integer    
servicesPaging.param string, or null    
servicesPaging.perPage integer    
servicesPaging.total integer    
servicesTotal integer    
startingKvno number    
trustRealm string, or null    

POST /admin-api/kerberos/principals/clear-person-keys

clearKerberosPersonKeys

Clear a directory person’s Kerberos keys

Removes the Kerberos keys derived from username’s password. Their next AS-REQ is refused with “sign in once”; their next verified sign-in derives new keys at the next kvno. Somebody with no keys answers cleared: false rather than a refusal, so a script may clear on every run. There is no operation that SETS a person’s keys: they come from the person’s password and from nothing else.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
username string yes The person, as they sign in — in the default trust realm’s directory.

200: Whether anything was cleared.

Member Type Required What it is
cleared boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
trustRealm string, or null    
username string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
cleared boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
trustRealm string, or null    
username string    

POST /admin-api/kerberos/principals/create-service

createKerberosServicePrincipal

Create a service principal with a random key, and get its keytab once

Makes a RANDOM key for every enctype in krb5.enctypes (never rc4-hmac in product mode), at kvno krb5.kvno, for spn in this KDC’s realm, stores them SEALED on the application entry for <spn>@<realm> (creating that entry if it is not there), and answers with an MIT keytab (format 0x502) in keytab, base64.

THE KEYTAB IS IN THIS REPLY AND NOWHERE ELSE: it cannot be downloaded again. A lost one is replaced by rotate-service.

The KDC issues tickets for that SPN under the stored key from the next request, in both modes, and this service’s own acceptor prefers it when the SPN is krb5.servicePrincipal. Refused for an SPN that already holds a stored key, for krbtgt/*, for another realm, and for anything that is not two or more /-separated components.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
spn string yes The service principal name, e.g. HTTP/web.example.com, with or without @<realm>.

200: The principal, kvno, enctypes, the keytab (base64) and a file name for it.

Member Type Required What it is
act string    
errors list    
errors[] string    
etypes list    
etypes[] integer    
keytab string    
keytabFilename string    
keytabKvnos list    
keytabKvnos[] integer    
kvno number    
message string    
ok boolean yes  
principal string    
retained list    
retained[].etypes list    
retained[].etypes[].etype integer    
retained[].etypes[].name string, or null    
retained[].expiresAt string    
retained[].kvno number    
retained[].retiredAt string    
sealed boolean    
spn string    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
act string    
errors list    
errors[] string    
etypes list    
etypes[] integer    
keytab string    
keytabFilename string    
keytabKvnos list    
keytabKvnos[] integer    
kvno number    
message string    
ok boolean yes  
principal string    
retained list    
retained[].etypes list    
retained[].etypes[].etype integer    
retained[].etypes[].name string, or null    
retained[].expiresAt string    
retained[].kvno number    
retained[].retiredAt string    
sealed boolean    
spn string    
trustRealm string, or null    

POST /admin-api/kerberos/principals/delete-service

deleteKerberosServicePrincipal

Delete a service principal’s stored key

Removes the stored key and its info from the application entry. The entry itself stays, as every entry this registry records does. A ticket for that SPN is then keyed as it was before a key was stored: from krb5.servicePassword if it is the acceptor’s own name, and not at all in product mode otherwise.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
spn string yes The service principal name.

200: The principal whose key was deleted.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
principal string    
spn string    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
principal string    
spn string    
trustRealm string, or null    

POST /admin-api/kerberos/principals/drop-previous-person-keys

dropKerberosPersonPreviousKeys

Stop accepting tickets under a person’s previous key versions, now

Removes the PREVIOUS key versions a password change kept for username, leaving their current keys — and so their sign-in — untouched. A ticket sealed under a dropped version is refused KRB_AP_ERR_BADKEYVER from the next request. A previous version was never a way in: pre-authentication uses the current keys only, so an old password is refused whether or not this is called. Nothing kept answers dropped: 0.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
username string yes The person, as they sign in — in the default trust realm’s directory.

200: How many previous versions were dropped, their kvnos, and the current kvno.

Member Type Required What it is
currentKvno number    
dropped integer    
errors list    
errors[] string    
kvnos list    
kvnos[] integer    
message string    
ok boolean yes  
principal string    
spn string    
trustRealm string, or null    
username string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
currentKvno number    
dropped integer    
errors list    
errors[] string    
kvnos list    
kvnos[] integer    
message string    
ok boolean yes  
principal string    
spn string    
trustRealm string, or null    
username string    

POST /admin-api/kerberos/principals/drop-previous-service-keys

dropKerberosServicePreviousKeys

Stop accepting tickets under a service principal’s previous key versions, now

Removes the PREVIOUS key versions a rotation kept for spn, leaving the current key and its keytab untouched. A ticket issued under a dropped version is refused KRB_AP_ERR_BADKEYVER from the next request, rather than when krb5.retainedKeyTtlS would have ended its window — which is what an operator wants after a keytab is compromised. Nothing kept answers dropped: 0 rather than a refusal. Refused for an SPN with no stored key, and for a key this service cannot open. Takes the realm’s own krbtgt/<REALM> too (#169), ending a krbtgt rotation’s window now.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
spn string yes The service principal name.

200: How many previous versions were dropped, their kvnos, and the current kvno.

Member Type Required What it is
currentKvno number    
dropped integer    
errors list    
errors[] string    
kvnos list    
kvnos[] integer    
message string    
ok boolean yes  
principal string    
spn string    
trustRealm string, or null    
username string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
currentKvno number    
dropped integer    
errors list    
errors[] string    
kvnos list    
kvnos[] integer    
message string    
ok boolean yes  
principal string    
spn string    
trustRealm string, or null    
username string    

POST /admin-api/kerberos/principals/reset-person-keytab

resetKerberosPersonKeytab

Reset a person’s password, and get the keytab derived from it once

SETS username’s password — to password, or with random: true to a generated one that is NEVER returned — and answers with an MIT keytab (format 0x502) in keytab, base64, derived from it: one entry per enctype in krb5.enctypes (never rc4-hmac in product mode), at the CURRENT kvno only.

THIS IS A PASSWORD RESET. A stored key is never read back out, so a keytab is derived from a password in hand, and the only one an administrator can have is one set now. The old password stops working in every protocol, the kvno moves up by one, an outstanding reset link is spent, the person is signed out of everything, and a CAEP credential-change is sent. They are NOT made to change it at their next sign-in (that would end the keytab), and a pending forced change is cleared.

The password is held to the realm’s password policy. The key derived from it is checked against the one the KDC holds before the keytab is returned. In DEVELOPMENT mode the KDC keys every user from krb5.userPassword, not from their own, so the keytab is derived from that — source says which. THE KEYTAB IS IN THIS REPLY AND NOWHERE ELSE. Refused, before anything changes, for a realm with no KDC, a name with no entry, a disabled account, and krb5.personKeys off in product mode; and for neither or both of password and random. The person makes their own, from their own password and with nothing reset, at /portal/kerberos.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
password string   The new password. Leave out with random.
random boolean   A generated password under the password policy, never returned.
username string yes The person, as they sign in, in the trust realm of the call.

200: The principal, kvno, enctypes, source (password or development), whether the password was generated, the sign-out, and the keytab (base64) with a file name for it.

Member Type Required What it is
errors list    
errors[] string    
etypes list    
etypes[] integer    
generated boolean    
keytab string    
keytabFilename string    
keytabKvnos list    
keytabKvnos[] integer    
kvno number    
message string    
ok boolean yes  
passwordSet boolean    
principal string    
problems list    
problems[] string    
realm string, or null    
reason string    
signedOut object    
signedOut.ended boolean    
signedOut.message string, or null    
signedOut.terminated number    
source string    
trustRealm string, or null    
username string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
etypes list    
etypes[] integer    
generated boolean    
keytab string    
keytabFilename string    
keytabKvnos list    
keytabKvnos[] integer    
kvno number    
message string    
ok boolean yes  
passwordSet boolean    
principal string    
problems list    
problems[] string    
realm string, or null    
reason string    
signedOut object    
signedOut.ended boolean    
signedOut.message string, or null    
signedOut.terminated number    
source string    
trustRealm string, or null    
username string    

POST /admin-api/kerberos/principals/rotate-krbtgt

rotateKerberosKrbtgt

Rotate the realm’s krbtgt key, keeping the one it replaces for the TGTs already sealed under it

Queues a run of the scheduler job krb5.krbtgt-rotate-now for the trust realm of the call, which runs once, on the scheduler’s leader, at its next tick: a new RANDOM key for every enctype in krb5.enctypes, at the next kvno, sealed on the directory entry krbtgt/<REALM>@<REALM>. The key it replaces is KEPT — at most krb5.retainedKeyVersions, for the longer of the ticket and renew lifetimes plus the clock skew unless krb5.retainedKeyTtlS names a number — so every TGT already issued goes on working until it expires. In development mode it replaces the key derived from krb5.krbtgtPassword, which is then the version kept.

NO KEY IS IN THE REPLY, OR ANYWHERE. The answer is the run’s id; GET /admin-api/kerberos/principals shows the krbtgt block with its new kvno once the run has happened. Refused in a realm with no KDC.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body (optional)

An empty object.

200: queued, the runId, and whether an identical run was already queued.

Member Type Required What it is
alreadyQueued boolean    
errors list    
errors[] string    
invalidate boolean    
message string    
ok boolean yes  
queued boolean    
runId number, or string    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
alreadyQueued boolean    
errors list    
errors[] string    
invalidate boolean    
message string    
ok boolean yes  
queued boolean    
runId number, or string    
trustRealm string, or null    

POST /admin-api/kerberos/principals/rotate-krbtgt-invalidate

rotateKerberosKrbtgtInvalidate

Rotate the realm’s krbtgt key and keep NOTHING, so every TGT in the realm is refused

Active Directory’s double reset in one act, for a krbtgt key presumed compromised: rotate-krbtgt with no previous version kept, so every TGT the realm issued before the run is refused KRB_AP_ERR_BADKEYVER at its next TGS-REQ and every person runs a fresh AS exchange. A Shared Signals event of this service’s own vocabulary (urn:iya:sts:secevent:event-type:kerberos-tickets-invalidated) says so to every stream that takes it. It is also the one act that replaces a stored krbtgt record this service cannot open. Needs confirm: "invalidate"; refused without it, and in a realm with no KDC.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
confirm one of invalidate yes The word invalidate, because this cannot be undone.

200: queued, the runId, and invalidate: true.

Member Type Required What it is
alreadyQueued boolean    
errors list    
errors[] string    
invalidate boolean    
message string    
ok boolean yes  
queued boolean    
runId number, or string    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
alreadyQueued boolean    
errors list    
errors[] string    
invalidate boolean    
message string    
ok boolean yes  
queued boolean    
runId number, or string    
trustRealm string, or null    

POST /admin-api/kerberos/principals/rotate-service

rotateKerberosServicePrincipal

Replace a service principal’s key, and get the new keytab once

New random keys at the stored kvno PLUS ONE, and the new keytab in keytab, base64.

THE VERSION IT REPLACES IS KEPT — at most krb5.retainedKeyVersions previous versions, each for krb5.retainedKeyTtlS (by default the ticket lifetime plus the clock skew) — and the keytab carries them too, as MIT’s ktadd leaves one: keytabKvnos lists every version in it and retained says until when each is accepted. A ticket already issued under a kept version is still accepted by this KDC and its acceptor; nothing new is issued under it, and past its window it is refused KRB_AP_ERR_BADKEYVER. drop-previous-service-keys ends the window at once. Refused for an SPN with no stored key.

Mirrors POST /admin/kerberos#kerberos-tab-principals, POST /admin/kerberos/principals on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
spn string yes The service principal name.

200: The principal, the new kvno, the enctypes and the new keytab (base64).

Member Type Required What it is
act string    
errors list    
errors[] string    
etypes list    
etypes[] integer    
keytab string    
keytabFilename string    
keytabKvnos list    
keytabKvnos[] integer    
kvno number    
message string    
ok boolean yes  
principal string    
retained list    
retained[].etypes list    
retained[].etypes[].etype integer    
retained[].etypes[].name string, or null    
retained[].expiresAt string    
retained[].kvno number    
retained[].retiredAt string    
sealed boolean    
spn string    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
act string    
errors list    
errors[] string    
etypes list    
etypes[] integer    
keytab string    
keytabFilename string    
keytabKvnos list    
keytabKvnos[] integer    
kvno number    
message string    
ok boolean yes  
principal string    
retained list    
retained[].etypes list    
retained[].etypes[].etype integer    
retained[].etypes[].name string, or null    
retained[].expiresAt string    
retained[].kvno number    
retained[].retiredAt string    
sealed boolean    
spn string    
trustRealm string, or null    

GET /admin-api/kerberos/trusts

getKerberosTrusts

The realm’s Kerberos trusts, with their keys described and never carried

The trust records of the realm the call is in, paged with ?trustsPage= and ?per=, and one record whole with ?trust=<partner realm> (trust, or unknownTrust naming a partner this realm holds no trust with).

Each row: the partner realm, NetBIOS name and domain SID, the type (external, trust-realm), the direction, the [MS-ADTS] 6.1.6.7.9 attributes by name and as the trustAttributes mask, the [MS-PAC] 4.1.2.2 boundary, the routed DNS suffixes, the enctypes, the forest trust information and claims transformation, and per key (incoming, outgoing) whether it is held, its kvno, its source and when it was set — the incoming side with the PREVIOUS version a rotation keeps and until when it is accepted. health lists the findings the console’s health column draws (kind, level, text).

form is what the add and edit forms are drawn from: the closed attribute set with its contradictions and requirements, the types, directions, key sources, enctypes, claims transformations, the shortest trust password, and the other trust realms a trust-realm partner may name. settings are the four the trusts read. NO KEY MATERIAL IS IN THIS REPLY.

Mirrors GET /admin/kerberos on the admin console.

The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).

Scope: admin:read.

Parameters

Name In Type Required What it is
per query integer   Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own.
trustsPage query integer   Which page of trusts to return, answered by trustsPaging. The realm’s trust records.
trust query string   One partner realm, for its record whole.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: The trust records with their paging and health, the drill-down record, what the forms are drawn from, and the trust settings.

Member Type Required What it is
actions list    
actions[] string    
form object    
form.attributes list    
form.attributes[] string    
form.claimsTransformations list    
form.claimsTransformations[] string    
form.contradictions list    
form.contradictions[].a string    
form.contradictions[].b string    
form.contradictions[].why string    
form.defaultAttributes list    
form.defaultAttributes[] string    
form.defaultEnctypes list    
form.defaultEnctypes[] integer    
form.directions list    
form.directions[] string    
form.enctypes list    
form.enctypes[].id integer    
form.enctypes[].name string, or null    
form.keySources list    
form.keySources[] string    
form.minPasswordLength integer    
form.requires list    
form.requires[].attribute string    
form.requires[].needs string    
form.requires[].why string    
form.trustRealms list    
form.trustRealms[].id string    
form.trustRealms[].kerberosRealm string    
form.types list    
form.types[] string    
kerberos object    
kerberos.active boolean    
kerberos.enabled boolean    
kerberos.kerberosRealm string, or null    
kerberos.reason string, or null    
kerberos.served list    
kerberos.served[] string    
kerberos.trustRealm string, or null    
product boolean    
protocolEndpoints list    
protocolEndpoints[].listening boolean    
protocolEndpoints[].methods list, or string    
protocolEndpoints[].methods[] string    
protocolEndpoints[].name string    
protocolEndpoints[].registered boolean    
protocolEndpoints[].route string    
protocolEndpoints[].transport string    
protocolEndpoints[].url string    
realm string, or null    
settings object    
settings.crossRealmClassicDelegation boolean    
settings.graceSeconds number    
settings.maxReferralHops number    
settings.requireSidFilteringInProduct boolean    
settings.trustKeyGraceSeconds number    
total integer    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    
trusts list    
trusts[].attributes list    
trusts[].attributes[] string    
trusts[].boundary string    
trusts[].claimsTransformation string    
trusts[].createdAt string, or null    
trusts[].direction string    
trusts[].enabled boolean    
trusts[].enctypeNames list    
trusts[].enctypeNames[].id integer    
trusts[].enctypeNames[].name string, or null    
trusts[].enctypes list    
trusts[].enctypes[] integer    
trusts[].forestTrustInfo object    
trusts[].forestTrustInfo.domains list    
trusts[].forestTrustInfo.domains[].dnsName string    
trusts[].forestTrustInfo.domains[].netbiosName string    
trusts[].forestTrustInfo.domains[].sid string    
trusts[].forestTrustInfo.domains[].sidEnabled boolean    
trusts[].forestTrustInfo.topLevelNames list    
trusts[].forestTrustInfo.topLevelNames[].enabled boolean    
trusts[].forestTrustInfo.topLevelNames[].name string    
trusts[].health list    
trusts[].health[].kind string    
trusts[].health[].level string    
trusts[].health[].params map   What the sentence is filled from.
trusts[].health[].params.{key} string    
trusts[].health[].text string    
trusts[].incoming object    
trusts[].incoming.held boolean    
trusts[].incoming.kvno number    
trusts[].incoming.previous object    
trusts[].incoming.previous.acceptedUntil string    
trusts[].incoming.previous.kvno number    
trusts[].incoming.previous.retiredAt string, or null    
trusts[].incoming.previous.source string    
trusts[].incoming.principal string    
trusts[].incoming.setAt string, or null    
trusts[].incoming.source string    
trusts[].lastKeyChangeAt string, or null    
trusts[].netbiosName string, or null    
trusts[].outgoing object    
trusts[].outgoing.held boolean    
trusts[].outgoing.kvno number    
trusts[].outgoing.principal string    
trusts[].outgoing.setAt string, or null    
trusts[].outgoing.source string    
trusts[].partnerRealm string    
trusts[].partnerSid string    
trusts[].partnerTrustRealm string    
trusts[].suffixes list    
trusts[].suffixes[] string    
trusts[].trustAttributes integer    
trusts[].trustDirection integer    
trusts[].type string    
trusts[].updatedAt string, or null    
trustsPaging object    
trustsPaging.firstRow integer    
trustsPaging.lastRow integer    
trustsPaging.noun string, or null    
trustsPaging.page integer    
trustsPaging.pages integer    
trustsPaging.param string, or null    
trustsPaging.perPage integer    
trustsPaging.total integer    
unknownTrust string    

POST /admin-api/kerberos/trusts/add

addKerberosTrust

Add a trust with another Kerberos realm

Writes a trust record in this realm’s directory (ou=kerberosTrusts) for partnerRealm. direction decides which keys it holds — inbound the incoming krbtgt/<us>@<partner> (the partner’s tickets are accepted), outbound the outgoing krbtgt/<partner>@<us> (this realm refers to the partner), bidirectional both — and keySource where each comes from: password, a shared trust password both KDCs derive the key from (RFC 3961 string-to-key, RFC 4120’s default salt), written and never shown back; or generate, random keys returned ONCE in shown. attributes are [MS-ADTS] 6.1.6.7.9’s bits by name (quarantined by default); a contradiction or a missing requirement is refused. forestTrustInfo belongs to a cross-forest trust only. Refused for this realm’s own name, a partner already held, and every field out of shape, each with its own code.

Mirrors POST /admin/kerberos#kerberos-tab-trusts, POST /admin/kerberos/trusts on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
attributes list   [MS-ADTS] 6.1.6.7.9’s bits by name.
attributes[] string    
attributesShown string   Set by the console’s form: the attribute boxes were drawn.
claimsTransformation one of drop-all, allow-all   What becomes of a claims set arriving across it.
direction one of bidirectional, inbound, outbound   Which keys the record holds.
enabled boolean   Whether it is used; true by default.
enctypes list   The enctypes its keys are made for, by number; AES by default.
enctypes[] integer or string    
forestDomains string   The form’s text: a domain per line, <sid> <dns name> <netbios name> [disabled].
forestNames string   The form’s text: a top-level name per line, <name> [disabled].
forestTrustInfo object or string, or null   A cross-forest trust’s { domains: [{ sid, dnsName, netbiosName, sidEnabled }], topLevelNames: [{ name, enabled }] }.
keySource one of password, generate   Where a key it does not hold yet comes from.
netbiosName string   Its NetBIOS (flat) name; the realm’s first label by default.
partnerRealm string yes The partner Kerberos realm, PARTNER.EXAMPLE.
partnerSid string   Its domain SID, S-1-5-21-a-b-c; a trust realm’s own by default.
partnerTrustRealm string   For trust-realm: that trust realm’s id.
password string   The shared trust password, for keySource: "password". Never shown back.
suffixes list   The DNS suffixes routed to the partner.
suffixes[] string    
type one of external, trust-realm   external — a KDC elsewhere — or trust-realm, another trust realm of this service.

200: The record’s public view in trust, and a generated key once in shown.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

POST /admin-api/kerberos/trusts/disable

disableKerberosTrust

Turn a trust off, keeping its keys

A disabled trust refers nobody and accepts no ticket (STS-KRB-0229); its keys are kept, so enable restores it as it was.

Mirrors POST /admin/kerberos#kerberos-tab-trusts, POST /admin/kerberos/trusts on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
partnerRealm string yes The partner Kerberos realm.

200: The record’s public view.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

POST /admin-api/kerberos/trusts/enable

enableKerberosTrust

Turn a trust on

The record for partnerRealm refers and accepts again, with the keys it kept.

Mirrors POST /admin/kerberos#kerberos-tab-trusts, POST /admin/kerberos/trusts on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
partnerRealm string yes The partner Kerberos realm.

200: The record’s public view.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

POST /admin-api/kerberos/trusts/pair

pairKerberosTrust

Write the matching record on the partner trust realm

For a record whose partner is another trust realm of this service (partnerRealm), writes that realm’s record for this one in the same act — its incoming key this realm’s outgoing and the other way round, the same attributes and enctypes — or, where it already holds one, makes its keys match. With otherRealm (a trust realm’s id) instead, writes BOTH records from nothing, from one password or one generated key set. Either way it writes another realm’s directory, so it is a service administrator’s act.

Mirrors POST /admin/kerberos#kerberos-tab-trusts, POST /admin/kerberos/trusts on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
attributes list   With otherRealm.
attributes[] string    
direction one of bidirectional, inbound, outbound   With otherRealm: the keys, from this realm’s side.
enctypes list   With otherRealm.
enctypes[] integer or string    
keySource one of password, generate   With otherRealm.
otherRealm string   A trust realm’s id, to pair from nothing.
partnerRealm string   A record held here, to mirror.
partnerSuffixes list   With otherRealm: what the other routes here.
partnerSuffixes[] string    
password string   With keySource: "password".
suffixes list   With otherRealm: what this realm routes to the other.
suffixes[] string    

200: Both records’ views, whether the other was created or matched, and a generated key once in shown.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

POST /admin-api/kerberos/trusts/remove

removeKerberosTrust

Remove a trust and its keys

Deletes the record for partnerRealm, keys and all: no referral is made through it and no ticket is accepted from it, at once. Confirmed by confirm repeating the partner realm (STS-ADMIN-0860 otherwise). disable keeps the keys instead.

Mirrors POST /admin/kerberos#kerberos-tab-trusts, POST /admin/kerberos/trusts on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
confirm string yes The partner realm again.
partnerRealm string yes The partner Kerberos realm.

200: Whether it was removed.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

POST /admin-api/kerberos/trusts/rotate-key

rotateKerberosTrustKey

Replace a trust’s keys at the next kvno, keeping the incoming one for a grace

New keys for side (both, the default, incoming or outgoing, of the sides held) at the current kvno plus one, from keySource. The incoming version it replaces still opens the partner’s tickets for krb5.trustKeyGraceSeconds (by default the ticket lifetime plus the clock skew) and is refused KRB_AP_ERR_BADKEYVER after it. With mirror: true and a trust-realm partner, that realm’s record is rotated in the same act the other way round — a service administrator’s act. Without it the partner’s administrator gives their side the same password or the keys in shown.

Mirrors POST /admin/kerberos#kerberos-tab-trusts, POST /admin/kerberos/trusts on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
keySource one of password, generate yes Where the new key comes from.
mirror boolean   Rotate the partner trust realm’s record too.
partnerRealm string yes The partner Kerberos realm.
password string   The new trust password, for keySource: "password".
side one of both, incoming, outgoing   Which keys.

200: The record’s view, the sides rotated, the partner realm’s record when mirrored, and a generated key once in shown.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

POST /admin-api/kerberos/trusts/update

updateKerberosTrust

Change a trust’s fields

Changes the record for partnerRealm: a field not given keeps its value. A key already held keeps its key — rotate-key changes one — and a direction that adds a side takes keySource for it, one that drops a side removes that key. The partner realm cannot change: every key is salted with it.

Mirrors POST /admin/kerberos#kerberos-tab-trusts, POST /admin/kerberos/trusts on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
attributes list   [MS-ADTS] 6.1.6.7.9’s bits by name.
attributes[] string    
attributesShown string   Set by the console’s form: the attribute boxes were drawn.
claimsTransformation one of drop-all, allow-all   What becomes of a claims set arriving across it.
direction one of bidirectional, inbound, outbound   Which keys the record holds.
enabled boolean   Whether it is used; true by default.
enctypes list   The enctypes its keys are made for, by number; AES by default.
enctypes[] integer or string    
forestDomains string   The form’s text: a domain per line, <sid> <dns name> <netbios name> [disabled].
forestNames string   The form’s text: a top-level name per line, <name> [disabled].
forestTrustInfo object or string, or null   A cross-forest trust’s { domains: [{ sid, dnsName, netbiosName, sidEnabled }], topLevelNames: [{ name, enabled }] }.
keySource one of password, generate   Where a key it does not hold yet comes from.
netbiosName string   Its NetBIOS (flat) name; the realm’s first label by default.
partnerRealm string yes The partner Kerberos realm, PARTNER.EXAMPLE.
partnerSid string   Its domain SID, S-1-5-21-a-b-c; a trust realm’s own by default.
partnerTrustRealm string   For trust-realm: that trust realm’s id.
password string   The shared trust password, for keySource: "password". Never shown back.
suffixes list   The DNS suffixes routed to the partner.
suffixes[] string    
type one of external, trust-realm   external — a KDC elsewhere — or trust-realm, another trust realm of this service.

200: The record’s public view in trust.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
action string    
created boolean    
errors list    
errors[] string    
here object    
here.attributes list    
here.attributes[] string    
here.boundary string    
here.claimsTransformation string    
here.createdAt string, or null    
here.direction string    
here.enabled boolean    
here.enctypeNames list    
here.enctypeNames[].id integer    
here.enctypeNames[].name string, or null    
here.enctypes list    
here.enctypes[] integer    
here.forestTrustInfo object    
here.forestTrustInfo.domains list    
here.forestTrustInfo.domains[].dnsName string    
here.forestTrustInfo.domains[].netbiosName string    
here.forestTrustInfo.domains[].sid string    
here.forestTrustInfo.domains[].sidEnabled boolean    
here.forestTrustInfo.topLevelNames list    
here.forestTrustInfo.topLevelNames[].enabled boolean    
here.forestTrustInfo.topLevelNames[].name string    
here.health list    
here.health[].kind string    
here.health[].level string    
here.health[].params map   What the sentence is filled from.
here.health[].params.{key} string    
here.health[].text string    
here.incoming object    
here.incoming.held boolean    
here.incoming.kvno number    
here.incoming.previous object    
here.incoming.previous.acceptedUntil string    
here.incoming.previous.kvno number    
here.incoming.previous.retiredAt string, or null    
here.incoming.previous.source string    
here.incoming.principal string    
here.incoming.setAt string, or null    
here.incoming.source string    
here.lastKeyChangeAt string, or null    
here.netbiosName string, or null    
here.outgoing object    
here.outgoing.held boolean    
here.outgoing.kvno number    
here.outgoing.principal string    
here.outgoing.setAt string, or null    
here.outgoing.source string    
here.partnerRealm string    
here.partnerSid string    
here.partnerTrustRealm string    
here.suffixes list    
here.suffixes[] string    
here.trustAttributes integer    
here.trustDirection integer    
here.type string    
here.updatedAt string, or null    
message string    
ok boolean yes  
otherRealm string    
rotated list    
rotated[] string    
shown object    
shown.incoming map   Base64 keys, by enctype number.
shown.incoming.{key} string    
shown.outgoing map   Base64 keys, by enctype number.
shown.outgoing.{key} string    
there object    
there.attributes list    
there.attributes[] string    
there.boundary string    
there.claimsTransformation string    
there.createdAt string, or null    
there.direction string    
there.enabled boolean    
there.enctypeNames list    
there.enctypeNames[].id integer    
there.enctypeNames[].name string, or null    
there.enctypes list    
there.enctypes[] integer    
there.forestTrustInfo object    
there.forestTrustInfo.domains list    
there.forestTrustInfo.domains[].dnsName string    
there.forestTrustInfo.domains[].netbiosName string    
there.forestTrustInfo.domains[].sid string    
there.forestTrustInfo.domains[].sidEnabled boolean    
there.forestTrustInfo.topLevelNames list    
there.forestTrustInfo.topLevelNames[].enabled boolean    
there.forestTrustInfo.topLevelNames[].name string    
there.health list    
there.health[].kind string    
there.health[].level string    
there.health[].params map   What the sentence is filled from.
there.health[].params.{key} string    
there.health[].text string    
there.incoming object    
there.incoming.held boolean    
there.incoming.kvno number    
there.incoming.previous object    
there.incoming.previous.acceptedUntil string    
there.incoming.previous.kvno number    
there.incoming.previous.retiredAt string, or null    
there.incoming.previous.source string    
there.incoming.principal string    
there.incoming.setAt string, or null    
there.incoming.source string    
there.lastKeyChangeAt string, or null    
there.netbiosName string, or null    
there.outgoing object    
there.outgoing.held boolean    
there.outgoing.kvno number    
there.outgoing.principal string    
there.outgoing.setAt string, or null    
there.outgoing.source string    
there.partnerRealm string    
there.partnerSid string    
there.partnerTrustRealm string    
there.suffixes list    
there.suffixes[] string    
there.trustAttributes integer    
there.trustDirection integer    
there.type string    
there.updatedAt string, or null    
trust object    
trust.attributes list    
trust.attributes[] string    
trust.boundary string    
trust.claimsTransformation string    
trust.createdAt string, or null    
trust.direction string    
trust.enabled boolean    
trust.enctypeNames list    
trust.enctypeNames[].id integer    
trust.enctypeNames[].name string, or null    
trust.enctypes list    
trust.enctypes[] integer    
trust.forestTrustInfo object    
trust.forestTrustInfo.domains list    
trust.forestTrustInfo.domains[].dnsName string    
trust.forestTrustInfo.domains[].netbiosName string    
trust.forestTrustInfo.domains[].sid string    
trust.forestTrustInfo.domains[].sidEnabled boolean    
trust.forestTrustInfo.topLevelNames list    
trust.forestTrustInfo.topLevelNames[].enabled boolean    
trust.forestTrustInfo.topLevelNames[].name string    
trust.health list    
trust.health[].kind string    
trust.health[].level string    
trust.health[].params map   What the sentence is filled from.
trust.health[].params.{key} string    
trust.health[].text string    
trust.incoming object    
trust.incoming.held boolean    
trust.incoming.kvno number    
trust.incoming.previous object    
trust.incoming.previous.acceptedUntil string    
trust.incoming.previous.kvno number    
trust.incoming.previous.retiredAt string, or null    
trust.incoming.previous.source string    
trust.incoming.principal string    
trust.incoming.setAt string, or null    
trust.incoming.source string    
trust.lastKeyChangeAt string, or null    
trust.netbiosName string, or null    
trust.outgoing object    
trust.outgoing.held boolean    
trust.outgoing.kvno number    
trust.outgoing.principal string    
trust.outgoing.setAt string, or null    
trust.outgoing.source string    
trust.partnerRealm string    
trust.partnerSid string    
trust.partnerTrustRealm string    
trust.suffixes list    
trust.suffixes[] string    
trust.trustAttributes integer    
trust.trustDirection integer    
trust.type string    
trust.updatedAt string, or null    
trustRealm string, or null