This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.
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/federation
getFederationRelationships
Every federation relationship, in either direction
This service can be EITHER END of a federation relationship, in five protocols: SAML 2.0, SAML 1.1, WS-Federation 1.2, OpenID Connect and OAuth 2.0.
This is the one feature here that has to be configured before it will do anything. Everywhere else this service accepts what it is given — any username, any client_id, any entityID, any LDAP bind. It cannot do that at an assertion consumer service: what arrives there is an unauthenticated HTTP request claiming to be a person, and the session it produces is the same one /oauth2/authorize, /wsfed, /saml2 and the admin console all read. So a relationship is created DISABLED, and an assertion is refused unless it verifies against the certificate configured on it.
And the gate is on the SUBJECT too (#109). A partner signs in only the person its (issuer, subject) is linked to — a federationLink on the entry — and what happens to a subject nobody linked is the relationship’s fedSubjectPolicy: a local sign-in as the person it names before linking (link-at-first-sign-in, the default), a refusal (pre-linked), a new namespaced entry (jit-namespaced), or, in development only, the old name match (any-existing). fedSubjectGroup, fedSubjectDomain and fedSubjectPattern narrow it further, and a console administrator is refused unless fedMayAssertAdministrators is on.
?relationship=<id> returns one of them, with everything it holds and the URLs to configure at the partner. It answers 200 with found: false for an id that is not registered.
This resource holds nothing: every row is an entry under ou=federations, the same one an ldapsearch reads.
Mirrors GET /admin/federation 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 |
|---|---|---|---|---|
relationship |
query | string | One relationship, by its id. | |
q |
query | string | Filter the list by id, name, partner or application. | |
role |
query | one of service-provider, identity-provider |
Only the relationships in which this service takes that role. service-provider is the direction that CONSUMES somebody else’s assertions. |
|
category |
query | one of enterprise, consumer |
Only the enterprise partners, or only the consumer and social providers (#565): a relationship that names a provider is consumer. |
|
page |
query | integer | Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually 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. | |
linksPage |
query | integer | Which page of links to return, answered by linksPaging. With relationship: the people whose federationLink is through it (#109), each { username, dn, link, issuer, subject }. |
|
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 relationships with the paging that found them, or one of them with its endpoints, its fields and what has crossed it.
| Member | Type | Required | What it is |
|---|---|---|---|
application |
string | ||
authentications |
integer | ||
autocreateDefault |
boolean | ||
base |
string | ||
category |
string | ||
categoryCounts |
map | ||
categoryCounts.{key} |
number | ||
consumerProviders |
object | ||
consumerProviders.catalogue |
list | ||
consumerProviders.catalogue[].adapters |
list | ||
consumerProviders.catalogue[].adapters[] |
string | ||
consumerProviders.catalogue[].claims |
list | ||
consumerProviders.catalogue[].claims[] |
string | ||
consumerProviders.catalogue[].defaults |
map | ||
consumerProviders.catalogue[].defaults.{key} |
string | ||
consumerProviders.catalogue[].docs |
string | ||
consumerProviders.catalogue[].emailVerified |
string | ||
consumerProviders.catalogue[].generic |
boolean | ||
consumerProviders.catalogue[].id |
string | ||
consumerProviders.catalogue[].label |
string | ||
consumerProviders.catalogue[].needs |
list | ||
consumerProviders.catalogue[].needs[] |
string | ||
consumerProviders.catalogue[].note |
string | ||
consumerProviders.catalogue[].protocol |
string | ||
consumerProviders.catalogue[].subject |
string | ||
consumerProviders.on |
boolean | ||
container |
string, or null | ||
defaultSubjectPolicy |
string | ||
dn |
string | ||
editable |
list | ||
editable[].editable |
boolean, or string | ||
editable[].enum |
list | ||
editable[].enum[] |
string | ||
editable[].from |
string | ||
editable[].kind |
string | ||
editable[].name |
string | ||
editable[].role |
string | ||
editable[].sensitive |
boolean | ||
editable[].standard |
boolean | ||
editable[].what |
string | ||
enabled |
boolean | ||
enabledNotConfigured |
integer | ||
encryption |
object | ||
encryption.allowUnencrypted |
boolean | ||
encryption.certificatePem |
string | ||
encryption.current |
string | ||
encryption.graceS |
number | ||
encryption.jwk |
object | ||
encryption.jwk.alg |
string | ||
encryption.jwk.crv |
string | ||
encryption.jwk.e |
string | ||
encryption.jwk.ek |
string | ||
encryption.jwk.ext |
boolean | ||
encryption.jwk.key_ops |
list | ||
encryption.jwk.key_ops[] |
string | ||
encryption.jwk.kid |
string | ||
encryption.jwk.kty |
string | ||
encryption.jwk.n |
string | ||
encryption.jwk.pub |
string | ||
encryption.jwk.use |
string | ||
encryption.jwk.x |
string | ||
encryption.jwk.x5c |
list | ||
encryption.jwk.x5c[] |
string | ||
encryption.jwk.x5t |
string | ||
encryption.jwk.x5t#S256 |
string | ||
encryption.jwk.x5u |
string | ||
encryption.jwk.y |
string | ||
encryption.keys |
list | ||
encryption.keys[].createdAt |
string, or number, or null | ||
encryption.keys[].decrypts |
boolean | ||
encryption.keys[].keyType |
string | ||
encryption.keys[].kid |
string | ||
encryption.keys[].notAfter |
string, or number, or null | ||
encryption.keys[].retiresAt |
string, or number, or null | ||
encryption.keys[].sealed |
boolean | ||
encryption.keys[].state |
string | ||
encryption.policy |
object | ||
encryption.policy.content |
string | ||
encryption.policy.family |
string | ||
encryption.policy.keyType |
string | ||
encryption.policy.management |
string | ||
encryption.required |
boolean | ||
encrypts |
boolean | ||
endpoints |
object | ||
endpoints.assertionConsumerService |
string | ||
endpoints.backchannelLogout |
string | ||
endpoints.frontchannelLogout |
string | ||
endpoints.initiateLogin |
string, or null | ||
endpoints.jwks |
string, or null | ||
endpoints.login |
string | ||
endpoints.metadata |
string, or null | ||
endpoints.postLogoutRedirect |
string | ||
endpoints.signOutCleanup |
string | ||
endpoints.singleLogout |
string | ||
enumLabels |
map | ||
enumLabels.{key} |
string | ||
fields |
object | ||
fields.cn |
string | ||
fields.description |
list | ||
fields.description[] |
string | ||
fields.fedAcceptSignout |
string | ||
fields.fedAllowUnencrypted |
string | ||
fields.fedAllowUnsolicited |
string | ||
fields.fedAllowedTenants |
list | ||
fields.fedAllowedTenants[] |
string | ||
fields.fedApplication |
string | ||
fields.fedApplicationUse |
list | ||
fields.fedApplicationUse[] |
string | ||
fields.fedAttributeMap |
list | ||
fields.fedAttributeMap[] |
string | ||
fields.fedAuthentications |
string | ||
fields.fedAuthnMechanism |
string | ||
fields.fedAuthnRelationship |
string | ||
fields.fedAuthorizeParams |
list | ||
fields.fedAuthorizeParams[] |
string | ||
fields.fedAutocreateUsers |
string | ||
fields.fedBinding |
string | ||
fields.fedClientId |
string | ||
fields.fedClientSecret |
string | ||
fields.fedClientSigningKey |
string | ||
fields.fedContentEncryptionAlgorithm |
string | ||
fields.fedDiscovery |
string | ||
fields.fedEmailsUrl |
string | ||
fields.fedEnabled |
string | ||
fields.fedEncryptionKey |
string | ||
fields.fedEncryptionKeyType |
string | ||
fields.fedEndSessionUrl |
string | ||
fields.fedFirstSeen |
string | ||
fields.fedHomeRealmDomain |
list | ||
fields.fedHomeRealmDomain[] |
string | ||
fields.fedId |
string | ||
fields.fedIdTokenSignedResponseAlg |
string | ||
fields.fedInitiateLogin |
string | ||
fields.fedJwks |
string | ||
fields.fedJwksUri |
string | ||
fields.fedKeyId |
string | ||
fields.fedKeyManagementAlgorithm |
string | ||
fields.fedLastError |
string | ||
fields.fedLastErrorAt |
string | ||
fields.fedLastSeen |
string | ||
fields.fedLastUser |
string | ||
fields.fedLocalEntityId |
string | ||
fields.fedMayAssertAdministrators |
string | ||
fields.fedName |
string | ||
fields.fedPeer |
string | ||
fields.fedProtocol |
string | ||
fields.fedProvider |
string | ||
fields.fedProvisionCap |
string | ||
fields.fedProvisionGroups |
string | ||
fields.fedProvisionIdleMinutes |
string | ||
fields.fedRefreshEverySeconds |
string | ||
fields.fedRefreshTokens |
string | ||
fields.fedRegister |
string | ||
fields.fedRegisteredIssuer |
string | ||
fields.fedRelease |
list | ||
fields.fedRelease[] |
string | ||
fields.fedRequestObject |
string | ||
fields.fedRequestObjectSigningAlg |
string | ||
fields.fedRequireSignedLogout |
string | ||
fields.fedResponseMode |
string | ||
fields.fedResponseType |
string | ||
fields.fedRole |
string | ||
fields.fedScope |
string | ||
fields.fedSignRequest |
string | ||
fields.fedSignalEmailMatch |
string | ||
fields.fedSignalsBearer |
string | ||
fields.fedSignalsClientId |
string | ||
fields.fedSignalsClientSecret |
string | ||
fields.fedSignalsDelivery |
string | ||
fields.fedSignalsEnabled |
string | ||
fields.fedSignalsEvents |
list | ||
fields.fedSignalsEvents[] |
string | ||
fields.fedSignalsIssuer |
string | ||
fields.fedSignalsScope |
string | ||
fields.fedSignalsTokenUrl |
string | ||
fields.fedSigningCertificate |
string | ||
fields.fedSloBinding |
string | ||
fields.fedSloUrl |
string | ||
fields.fedSsoUrl |
string | ||
fields.fedSubjectClaim |
string | ||
fields.fedSubjectDomain |
list | ||
fields.fedSubjectDomain[] |
string | ||
fields.fedSubjectGroup |
list | ||
fields.fedSubjectGroup[] |
string | ||
fields.fedSubjectPattern |
string | ||
fields.fedSubjectPolicy |
string | ||
fields.fedTeamId |
string | ||
fields.fedTokenAuth |
string | ||
fields.fedTokenUrl |
string | ||
fields.fedTrustAnchor |
string | ||
fields.fedUpdateUserAttributes |
string | ||
fields.fedUserinfoSignedResponseAlg |
string | ||
fields.fedUserinfoUrl |
string | ||
fields.fedUsernameSource |
string | ||
fields.fedUsers |
string | ||
fields.fedWebFinger |
string | ||
filter |
object | ||
filter.category |
string, or null | ||
filter.q |
string, or null | ||
filter.role |
string, or null | ||
firstRow |
integer | ||
found |
boolean | ||
id |
string | ||
lastError |
string | ||
lastErrorAt |
string | ||
lastRow |
integer | ||
lastSeen |
string | ||
lastUser |
string | ||
links |
list | ||
links[].dn |
string | ||
links[].issuer |
string | ||
links[].link |
string | ||
links[].subject |
string | ||
links[].username |
string | ||
linksPaging |
object | ||
linksPaging.firstRow |
integer | ||
linksPaging.lastRow |
integer | ||
linksPaging.noun |
string | ||
linksPaging.page |
integer | ||
linksPaging.pages |
integer | ||
linksPaging.param |
string | ||
linksPaging.perPage |
integer | ||
linksPaging.total |
integer | ||
loginHref |
string | ||
mappings |
list | ||
mappings[] |
string | ||
matched |
integer | ||
max |
number | ||
metadataUrl |
string | ||
missing |
list | ||
missing[] |
string | ||
multiFields |
list | ||
multiFields[].editable |
boolean, or string | ||
multiFields[].enum |
list | ||
multiFields[].enum[] |
string | ||
multiFields[].from |
string | ||
multiFields[].kind |
string | ||
multiFields[].name |
string | ||
multiFields[].role |
string | ||
multiFields[].sensitive |
boolean | ||
multiFields[].standard |
boolean | ||
multiFields[].what |
string | ||
name |
string | ||
outboundSignals |
object | ||
outboundSignals.application |
string | ||
outboundSignals.streams |
list | ||
outboundSignals.streams[].createdBy |
string | ||
outboundSignals.streams[].dead |
boolean | ||
outboundSignals.streams[].deadLetters |
integer | ||
outboundSignals.streams[].delivery |
string | ||
outboundSignals.streams[].eventsDelivered |
list | ||
outboundSignals.streams[].eventsDelivered[] |
string | ||
outboundSignals.streams[].lastActivityAt |
string | ||
outboundSignals.streams[].status |
string | ||
outboundSignals.streams[].streamId |
string | ||
page |
integer | ||
pages |
integer | ||
paging |
object | ||
paging.firstRow |
integer | ||
paging.lastRow |
integer | ||
paging.noun |
string | ||
paging.page |
integer | ||
paging.pages |
integer | ||
paging.param |
string | ||
paging.perPage |
integer | ||
paging.total |
integer | ||
paths |
object | ||
paths.acs |
string | ||
paths.atprotoClient |
string | ||
paths.backchannelLogout |
string | ||
paths.base |
string | ||
paths.fragmentScript |
string | ||
paths.frontchannelLogout |
string | ||
paths.initiateLogin |
string | ||
paths.jwks |
string | ||
paths.link |
string | ||
paths.login |
string | ||
paths.metadata |
string | ||
paths.notifications |
string | ||
paths.profile |
string | ||
paths.requestObject |
string | ||
paths.signals |
string | ||
paths.slo |
string | ||
paths.stepup |
string | ||
paths.webfinger |
string | ||
peer |
string | ||
perPage |
integer | ||
protocol |
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 | ||
protocolLabel |
string | ||
protocols |
list | ||
protocols[].family |
string | ||
protocols[].label |
string | ||
protocols[].needs |
list | ||
protocols[].needs[] |
string | ||
protocols[].protocol |
string | ||
protocols[].signalsOnly |
boolean | ||
protocols[].spec |
string | ||
protocols[].what |
string | ||
provider |
object, or string, or null | ||
provider.docs |
string | ||
provider.id |
string | ||
provider.label |
string | ||
provider.note |
string | ||
provider.realmOn |
boolean | ||
providerLabel |
string | ||
ready |
integer, or boolean | ||
relationshipCount |
integer | ||
relationships |
list | ||
relationships[].application |
string | ||
relationships[].authentications |
integer | ||
relationships[].category |
string | ||
relationships[].dn |
string | ||
relationships[].enabled |
boolean | ||
relationships[].id |
string | ||
relationships[].lastError |
string | ||
relationships[].lastErrorAt |
string | ||
relationships[].lastSeen |
string | ||
relationships[].lastUser |
string | ||
relationships[].mappings |
list | ||
relationships[].mappings[] |
string | ||
relationships[].missing |
list | ||
relationships[].missing[] |
string | ||
relationships[].name |
string | ||
relationships[].peer |
string | ||
relationships[].protocol |
string | ||
relationships[].protocolLabel |
string | ||
relationships[].provider |
string | ||
relationships[].providerLabel |
string | ||
relationships[].ready |
boolean | ||
relationships[].releases |
list | ||
relationships[].releases[] |
string | ||
relationships[].role |
string | ||
relationships[].roleLabel |
string | ||
relationships[].signalsEnabled |
boolean | ||
relationships[].signsIn |
boolean | ||
relationships[].usable |
boolean | ||
relationships[].users |
integer | ||
releases |
list | ||
releases[] |
string | ||
role |
string | ||
roleCounts |
map | ||
roleCounts.{key} |
number | ||
roleLabel |
string | ||
roles |
list | ||
roles[].label |
string | ||
roles[].role |
string | ||
roles[].short |
string | ||
roles[].what |
string | ||
schema |
list | ||
schema[].editable |
boolean, or string | ||
schema[].enum |
list | ||
schema[].enum[] |
string | ||
schema[].from |
string | ||
schema[].kind |
string | ||
schema[].name |
string | ||
schema[].role |
string | ||
schema[].sensitive |
boolean | ||
schema[].standard |
boolean | ||
schema[].what |
string | ||
setFields |
list | ||
setFields[].editable |
boolean, or string | ||
setFields[].enum |
list | ||
setFields[].enum[] |
string | ||
setFields[].from |
string | ||
setFields[].kind |
string | ||
setFields[].name |
string | ||
setFields[].role |
string | ||
setFields[].sensitive |
boolean | ||
setFields[].standard |
boolean | ||
setFields[].what |
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 | ||
settings.editableCount |
integer | ||
settings.groups |
list | ||
settings.groups[].group |
string | ||
settings.groups[].settings |
list | ||
settings.groups[].settings[].appconfigPath |
string | ||
settings.groups[].settings[].csvValueNotes |
map | ||
settings.groups[].settings[].csvValueNotes.{key} |
string | ||
settings.groups[].settings[].csvValues |
list | ||
settings.groups[].settings[].csvValues[] |
string, or number, or boolean, or null | ||
settings.groups[].settings[].default |
list, or string, or number, or boolean, or null | ||
settings.groups[].settings[].default[] |
string, or number, or boolean, or null | ||
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, or number, or boolean, or null | ||
settings.groups[].settings[].env |
list, or string | ||
settings.groups[].settings[].env[] |
string | ||
settings.groups[].settings[].group |
string | ||
settings.groups[].settings[].key |
string | ||
settings.groups[].settings[].label |
string | ||
settings.groups[].settings[].legacyEnv |
list, or string | ||
settings.groups[].settings[].legacyEnv[] |
string | ||
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 |
object | ||
settings.groups[].settings[].selectAll.aloneWhileOn |
list | ||
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.aloneWhileOn[].values |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn |
list | ||
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].on |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].setting |
object | Nested deeper than this page draws. | |
settings.groups[].settings[].selectAll.onlyWhileOn[].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 string, or number, or boolean, or null | ||
settings.groups[].settings[].value[] |
string, or number, or boolean, or null | ||
settings.overridden |
list | ||
settings.overridden[] |
string | ||
settings.page |
string | ||
settings.setWith |
string | ||
settings.settingCount |
integer | ||
settings.sharedWith |
map | ||
settings.sharedWith.{key} |
list | ||
settings.sharedWith.{key}[].label |
string | ||
settings.sharedWith.{key}[].path |
string | ||
shown |
integer | ||
signOut |
object | ||
signOut.backchannelLogout |
string | ||
signOut.frontchannelLogout |
string | ||
signOut.postLogoutRedirect |
string | ||
signOut.signOutCleanup |
string | ||
signOut.singleLogout |
string | ||
signalArrivals |
list | ||
signalArrivals[].events |
list | ||
signalArrivals[].events[] |
string | ||
signalArrivals[].iat |
number | ||
signalArrivals[].jti |
string | ||
signalArrivals[].mapping |
string | ||
signalArrivals[].person |
string | ||
signalArrivals[].reactions |
list | ||
signalArrivals[].reactions[].codes |
integer | ||
signalArrivals[].reactions[].done |
boolean | ||
signalArrivals[].reactions[].ended |
integer | ||
signalArrivals[].reactions[].event |
string | ||
signalArrivals[].reactions[].gnapGrants |
integer | ||
signalArrivals[].reactions[].oauthGrants |
integer | ||
signalArrivals[].reactions[].observed |
boolean | ||
signalArrivals[].reactions[].reaction |
string | ||
signalArrivals[].reactions[].revoked |
integer | ||
signalArrivals[].reactions[].skipped |
string | ||
signalArrivals[].reactions[].status |
string | ||
signalArrivals[].reactions[].tokens |
integer | ||
signalArrivals[].reactions[].why |
string | ||
signalArrivals[].receivedAt |
string | ||
signalArrivals[].refusal |
string | ||
signalArrivals[].relationship |
string | ||
signalArrivals[].subject |
any JSON | An RFC 9493 subject identifier as a partner’s SET carried it, in whatever format that partner chose. An RFC 9493 subject identifier as a partner’s SET carried it, in whatever format that partner chose. | |
signalArrivals[].verified |
boolean | ||
signalArrivals[].via |
string | ||
signalArrivals[].why |
string | ||
signalSetFields |
list | ||
signalSetFields[].editable |
boolean, or string | ||
signalSetFields[].enum |
list | ||
signalSetFields[].enum[] |
string | ||
signalSetFields[].from |
string | ||
signalSetFields[].kind |
string | ||
signalSetFields[].name |
string | ||
signalSetFields[].role |
string | ||
signalSetFields[].sensitive |
boolean | ||
signalSetFields[].standard |
boolean | ||
signalSetFields[].what |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string | ||
signalsEnabled |
boolean | ||
signsIn |
boolean | ||
subjectPolicy |
string | ||
unmappedAttributes |
list | ||
unmappedAttributes[].first |
string | ||
unmappedAttributes[].last |
string | ||
unmappedAttributes[].name |
string | ||
unmappedAttributes[].refused |
string | ||
usable |
boolean | ||
users |
integer |
400: The answer.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/federation/add-value
addFederationValue
Add a value to a multi-valued field
Any multi-valued field: the relationship’s own editable table marks them, and this operation’s field lists them. A field holding one value is refused rather than assigned (#747). Two have rules of their own.
fedAttributeMap is written <incoming name>=<LDAP attribute> and is split at the FIRST equals sign — which matters, because an incoming name can be a URL and a URL can hold one. It is only needed for a partner’s own inventions: the ordinary OpenID Connect claims, the SAML urn:oid: names and the AD FS claim URIs are mapped already.
fedRelease names an attribute or claim released to that partner, and it can only REMOVE — from what /admin/claims, /admin/saml-attributes and the groups claim would add, and from nothing else. It cannot touch sub, iss, exp or a NameID. NO VALUES MEANS NO POLICY, not release nothing: adding the first value here is what starts the filtering.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
field |
one of description, fedAllowedTenants, fedAuthorizeParams, fedAttributeMap, fedSubjectGroup, fedSubjectDomain, fedHomeRealmDomain, fedSignalsEvents, fedRelease |
yes | Which list. |
id |
string | yes | The relationship. |
value |
string | yes | The value to add. |
200: The relationship with the value added.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
POST /admin-api/federation/check-partner
checkFederationPartner
Check an OpenID Connect partner’s configuration
Service-provider-side OpenID Connect relationships only (#930). Fetches what a sign-in would: the partner’s discovery document where fedDiscovery is on — its issuer held to fedPeer — and its key set, and answers the endpoints and how many keys this service can read. Writes nothing and signs nobody in.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: issuer, endpoints, discovered, keys and readable.
| Member | Type | Required | What it is |
|---|---|---|---|
discovered |
boolean | ||
endpoints |
object | ||
endpoints.authorization_endpoint |
string | ||
endpoints.jwks_uri |
string | ||
endpoints.token_endpoint |
string | ||
endpoints.userinfo_endpoint |
string | ||
errors |
list | ||
errors[] |
string | ||
issuer |
string | ||
keys |
integer | ||
message |
string | ||
ok |
boolean | yes | |
readable |
integer | ||
why |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
discovered |
boolean | ||
endpoints |
object | ||
endpoints.authorization_endpoint |
string | ||
endpoints.jwks_uri |
string | ||
endpoints.token_endpoint |
string | ||
endpoints.userinfo_endpoint |
string | ||
errors |
list | ||
errors[] |
string | ||
issuer |
string | ||
keys |
integer | ||
message |
string | ||
ok |
boolean | yes | |
readable |
integer | ||
why |
string |
POST /admin-api/federation/create
createFederationRelationship
Register a federation relationship
It is created DISABLED, whatever this request says, and nothing about it does anything until enable is called. That is the one place this operation overrides its input, and it is deliberate: a partner that half-exists and silently accepts assertions is the failure this whole register is arranged to prevent, so enabling is a second act that says the configuration is finished.
ONE RELATIONSHIP IS ONE DIRECTION. A partner this service both consumes from and asserts to is two relationships with two ids, because everything that configures one differs by direction.
The reply carries readiness.missing — the fields this protocol and role still need — so a caller can go straight on to set for each of them without knowing the schema in advance.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
application |
string | On an identity-provider-side relationship only: the identifier of the partner’s entry in ou=applications. Its entityID, redirect URIs and certificate stay THERE, where every protocol module reads them — this register holds a pointer and not a copy. |
|
clientId |
string | With provider: this service’s client_id at the provider, set as fedClientId in the same act. |
|
clientSecret |
string | With provider: this service’s secret at the provider, set as fedClientSecret in the same act and sealed as that field always is. Never echoed. |
|
id |
string | yes | The key, the RDN and a URL segment. It has to start with a letter or a digit and hold only letters, digits, dot, dash and underscore, up to 63 characters. |
name |
string | What to call the partner on a page. The id is the name when this is omitted. | |
peer |
string | The partner’s own identifier — a SAML entityID, an OpenID Connect issuer, a WS-Federation wtrealm. On a service-provider-side relationship it is CHECKED: an assertion whose issuer is not this string is refused even when the signature verifies. | |
protocol |
one of saml2, saml11, wsfed, oidc, oauth2, ssf |
yes | The protocol the relationship runs in. ssf (#374) is a partner that signs nobody in and only sends Shared Signals; it takes the service-provider role. |
provider |
one of google, discord, github, microsoft, microsoft-any, linkedin, yahoo, slack, twitch, salesforce, facebook, amazon, spotify, x, tiktok, apple, gitlab, gitlab-self-managed, bitbucket, patreon, roblox, battlenet, epic, paypal, dropbox, box, steam, codeberg, gitea, huggingface, asana, atlassian, replit, mastodon, sourceforge, stackoverflow, oschina, discourse, bluesky, generic-oidc, generic-oauth2 |
A CONSUMER OR SOCIAL PROVIDER (#565): the profile the relationship is made from. Its endpoints, issuer, scope and token authentication are written onto the relationship, role must be service-provider and protocol the profile’s (both are in consumerProviders on GET /admin-api/federation), and the realm must have federation.consumerProviders on. |
|
role |
one of service-provider, identity-provider |
yes | Which end THIS SERVICE is. service-provider means a foreign identity provider authenticates the person and this service consumes what it issues. |
200: The relationship as created, and what it still needs before it can be enabled usefully.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
POST /admin-api/federation/delete
deleteFederationRelationship
Delete a relationship
The entry goes and takes its recorded sign-ins with it. The PEOPLE it authenticated keep their entries under ou=users — nothing is ever deleted from there — and any session they hold is unaffected until it expires or is ended, which is what POST /admin-api/logout is for.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: Confirmation, and what was deliberately left behind.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes |
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 |
POST /admin-api/federation/disable
disableFederationRelationship
Turn a relationship off
A response arriving for a disabled relationship is refused without being looked at, which is what disabling is for. Nothing else is lost: the configuration, the counters and the mappings all stay, and the people it authenticated keep their directory entries and their sessions.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship, now disabled.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
POST /admin-api/federation/enable
enableFederationRelationship
Turn a relationship on
The second, deliberate act. It is allowed on a relationship that is not fully configured, and that is not a gap: a half-configured partner is a state somebody is passing through, and refusing to save it would mean configuring everything in one request with no way back. What happens in that state is that every endpoint for the relationship REFUSES and says which fields are missing — it never half-works — and the reply to this operation says so too.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship, and whether it is now usable.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
POST /admin-api/federation/register-partner
registerAtFederationPartner
Register this service at an OpenID Connect partner
A relationship with fedDiscovery and fedRegister on (#930): reads the partner’s discovery document and registers this relationship at its registration_endpoint (RFC 7591), writing the client_id and secret it answers to fedClientId and fedClientSecret (sealed) and the issuer to fedRegisteredIssuer. Registers again whatever client the relationship held.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: clientId and issuer.
| Member | Type | Required | What it is |
|---|---|---|---|
clientId |
string | ||
errors |
list | ||
errors[] |
string | ||
issuer |
string | ||
message |
string | ||
ok |
boolean | yes |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
clientId |
string | ||
errors |
list | ||
errors[] |
string | ||
issuer |
string | ||
message |
string | ||
ok |
boolean | yes |
POST /admin-api/federation/remove-value
removeFederationValue
Remove one value from a multi-valued field
Refused if that value is not there, rather than succeeding silently: a caller removing a mapping it thinks exists wants to hear that it does not.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
field |
one of description, fedAllowedTenants, fedAuthorizeParams, fedAttributeMap, fedSubjectGroup, fedSubjectDomain, fedHomeRealmDomain, fedSignalsEvents, fedRelease |
yes | Which list. |
id |
string | yes | The relationship. |
value |
string | yes | The value to remove, exactly as it stands. |
200: The relationship with the value gone.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
POST /admin-api/federation/rotate-key
rotateFederationKey
Rotate a relationship’s encryption key
SAML 2.0, WS-Federation and OpenID Connect service-provider-side relationships only (#168). A new key of the relationship’s fedEncryptionKeyType is issued under this realm’s Intermediate and becomes CURRENT — what /federation/metadata/{id} and /federation/jwks/{id} publish. The key it replaces still DECRYPTS for federation.encryptionKeyGraceS, so a partner still holding the old certificate is not refused mid-change, and then decrypts nothing; the scheduler job federation.encryption-key-retire removes it. A second rotation inside that window drops the older key at once. Also the way to issue a key for a relationship that has none.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The new key’s kid, and the relationship as it now stands.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
POST /admin-api/federation/set
setFederationField
Set one single-valued field on a relationship
The field must be one of this relationship’s — a field belonging to the other ROLE is refused by name rather than written and ignored, and so is one that records what HAPPENED (the counters, the last error).
fedId, fedRole and fedProtocol are refused too, and that is a third category rather than an oversight: they are the relationship’s identity, and changing one would leave a SAML relationship carrying a token endpoint. Delete it and make another — there is no state to lose but the counters.
GET /admin-api/federation?relationship=<id> returns editable, which is exactly the list this operation accepts, so a caller need not guess.
The reply always carries readiness, so setting the last missing field tells you it was the last one.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
field |
one of fedName, fedPeer, fedLocalEntityId, fedEnabled, fedSsoUrl, fedTokenUrl, fedUserinfoUrl, fedJwksUri, fedEmailsUrl, fedJwks, fedTrustAnchor, fedSigningCertificate, fedClientId, fedClientSecret, fedResponseMode, fedTeamId, fedKeyId, fedClientSigningKey, fedTokenAuth, fedScope, fedResponseType, fedIdTokenSignedResponseAlg, fedUserinfoSignedResponseAlg, fedRefreshTokens, fedRefreshEverySeconds, fedRegister, fedRegisteredIssuer, fedRequestObject, fedRequestObjectSigningAlg, fedWebFinger, fedDiscovery, fedInitiateLogin, fedBinding, fedSignRequest, fedUsernameSource, fedSubjectClaim, fedAutocreateUsers, fedUpdateUserAttributes, fedProvisionGroups, fedProvisionCap, fedProvisionIdleMinutes, fedSubjectPolicy, fedSubjectPattern, fedMayAssertAdministrators, fedSignalEmailMatch, fedSignalsEnabled, fedSignalsIssuer, fedSignalsDelivery, fedSignalsTokenUrl, fedSignalsClientId, fedSignalsClientSecret, fedSignalsScope, fedSignalsBearer, fedSloUrl, fedSloBinding, fedEndSessionUrl, fedAcceptSignout, fedRequireSignedLogout, fedEncryptionKeyType, fedKeyManagementAlgorithm, fedContentEncryptionAlgorithm, fedAllowUnencrypted, fedAllowUnsolicited, fedApplication, fedAuthnMechanism, fedAuthnRelationship |
yes | The attribute name, e.g. fedSsoUrl, fedSigningCertificate, fedClientId. |
id |
string | yes | The relationship. |
value |
string | yes | The new value. An empty string clears it. fedSigningCertificate is normalised — PEM armour and whitespace are stripped, because what the schema holds is the base64 DER a ds:X509Certificate carries. |
200: The relationship as it now stands, and whether it is ready.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
errors |
list | ||
errors[] |
string | ||
kid |
string | ||
message |
string | ||
ok |
boolean | yes | |
readiness |
object | ||
readiness.missing |
list | ||
readiness.missing[] |
string | ||
readiness.ready |
boolean | ||
relationship |
object | ||
relationship.cn |
string | ||
relationship.createdAt |
string, or number, or null | ||
relationship.description |
list | ||
relationship.description[] |
string | ||
relationship.dn |
string | ||
relationship.fedAcceptSignout |
string | ||
relationship.fedAllowUnencrypted |
string | ||
relationship.fedAllowUnsolicited |
string | ||
relationship.fedAllowedTenants |
list | ||
relationship.fedAllowedTenants[] |
string | ||
relationship.fedApplication |
string | ||
relationship.fedApplicationUse |
list | ||
relationship.fedApplicationUse[] |
string | ||
relationship.fedAttributeMap |
list | ||
relationship.fedAttributeMap[] |
string | ||
relationship.fedAuthentications |
string | ||
relationship.fedAuthnMechanism |
string | ||
relationship.fedAuthnRelationship |
string | ||
relationship.fedAuthorizeParams |
list | ||
relationship.fedAuthorizeParams[] |
string | ||
relationship.fedAutocreateUsers |
string | ||
relationship.fedBinding |
string | ||
relationship.fedClientId |
string | ||
relationship.fedContentEncryptionAlgorithm |
string | ||
relationship.fedDiscovery |
string | ||
relationship.fedEmailsUrl |
string | ||
relationship.fedEnabled |
string | ||
relationship.fedEncryptionKeyType |
string | ||
relationship.fedEndSessionUrl |
string | ||
relationship.fedFirstSeen |
string | ||
relationship.fedHomeRealmDomain |
list | ||
relationship.fedHomeRealmDomain[] |
string | ||
relationship.fedId |
string | ||
relationship.fedIdTokenSignedResponseAlg |
string | ||
relationship.fedInitiateLogin |
string | ||
relationship.fedJwks |
string | ||
relationship.fedJwksUri |
string | ||
relationship.fedKeyId |
string | ||
relationship.fedKeyManagementAlgorithm |
string | ||
relationship.fedLastError |
string | ||
relationship.fedLastErrorAt |
string | ||
relationship.fedLastSeen |
string | ||
relationship.fedLastUser |
string | ||
relationship.fedLocalEntityId |
string | ||
relationship.fedMayAssertAdministrators |
string | ||
relationship.fedName |
string | ||
relationship.fedPeer |
string | ||
relationship.fedProtocol |
string | ||
relationship.fedProvider |
string | ||
relationship.fedProvisionCap |
string | ||
relationship.fedProvisionGroups |
string | ||
relationship.fedProvisionIdleMinutes |
string | ||
relationship.fedRefreshEverySeconds |
string | ||
relationship.fedRefreshTokens |
string | ||
relationship.fedRegister |
string | ||
relationship.fedRegisteredIssuer |
string | ||
relationship.fedRelease |
list | ||
relationship.fedRelease[] |
string | ||
relationship.fedRequestObject |
string | ||
relationship.fedRequestObjectSigningAlg |
string | ||
relationship.fedRequireSignedLogout |
string | ||
relationship.fedResponseMode |
string | ||
relationship.fedResponseType |
string | ||
relationship.fedRole |
string | ||
relationship.fedScope |
string | ||
relationship.fedSignRequest |
string | ||
relationship.fedSignalEmailMatch |
string | ||
relationship.fedSignalsClientId |
string | ||
relationship.fedSignalsDelivery |
string | ||
relationship.fedSignalsEnabled |
string | ||
relationship.fedSignalsEvents |
list | ||
relationship.fedSignalsEvents[] |
string | ||
relationship.fedSignalsIssuer |
string | ||
relationship.fedSignalsScope |
string | ||
relationship.fedSignalsTokenUrl |
string | ||
relationship.fedSigningCertificate |
string | ||
relationship.fedSloBinding |
string | ||
relationship.fedSloUrl |
string | ||
relationship.fedSsoUrl |
string | ||
relationship.fedSubjectClaim |
string | ||
relationship.fedSubjectDomain |
list | ||
relationship.fedSubjectDomain[] |
string | ||
relationship.fedSubjectGroup |
list | ||
relationship.fedSubjectGroup[] |
string | ||
relationship.fedSubjectPattern |
string | ||
relationship.fedSubjectPolicy |
string | ||
relationship.fedTeamId |
string | ||
relationship.fedTokenAuth |
string | ||
relationship.fedTokenUrl |
string | ||
relationship.fedTrustAnchor |
string | ||
relationship.fedUpdateUserAttributes |
string | ||
relationship.fedUserinfoSignedResponseAlg |
string | ||
relationship.fedUserinfoUrl |
string | ||
relationship.fedUsernameSource |
string | ||
relationship.fedUsers |
string | ||
relationship.fedWebFinger |
string | ||
relationship.modifiedAt |
string, or number, or null |
POST /admin-api/federation/signals-add-subject
addFederationSignalsSubject
Add a subject to the stream at the partner
SSF 1.0 section 8.1.3.2. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
subject |
object | yes |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-create-stream
createFederationSignalsStream
Create this realm’s stream at the partner
SSF 1.0 section 8.1.1, discovering first where needed: a poll stream, or — fedSignalsDelivery push — a push stream to /federation/signals/{id} with an authorization header only this realm and the partner know. Asks for fedSignalsEvents. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-delete-stream
deleteFederationSignalsStream
Delete the stream at the partner
Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-discover
discoverFederationSignals
Discover the partner’s Shared Signals configuration
Fetches /.well-known/ssf-configuration under the SSF issuer (fedSignalsIssuer, else fedPeer; SSF 1.0 section 7), which must name that issuer, a jwks_uri and a configuration_endpoint, and fetches the keys. Every address dialled afterwards is one that document named. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-poll-now
pollFederationSignals
Poll the partner now
RFC 8936, as the ssf.foreign-poll job does.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-read-status
readFederationSignalsStatus
Read the stream’s status from the partner
SSF 1.0 section 8.1.2.1; the status is held and shown. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-read-stream
readFederationSignalsStream
Read the stream’s configuration from the partner
Refreshes what is held: audience, events, delivery.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-remove-subject
removeFederationSignalsSubject
Remove a subject from the stream at the partner
SSF 1.0 section 8.1.3.3. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
subject |
object | yes |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-replace-stream
replaceFederationSignalsStream
Replace the stream’s configuration at the partner
SSF 1.0 section 8.1.1.4: a PUT of the stream_id and every receiver-supplied property — the delivery the stream has, fedSignalsEvents as events_requested, the description. A push stream is given a new authorization header, held once the partner accepts it. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-set-status
setFederationSignalsStatus
Enable, pause or disable the stream at the partner
SSF 1.0 section 8.1.2. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
reason |
string | ||
status |
one of enabled, paused, disabled |
yes |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-unblock
unblockFederationSignals
Lift a partner’s block on a person’s sign-ins
A verified account-disabled from a sign-in partner blocks its sign-ins of the person until its account-enabled (#373). This lifts the block by hand. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
user |
string | yes | The person. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-update-stream
updateFederationSignalsStream
Send fedSignalsEvents to the stream
A PATCH of events_requested to the relationship’s fedSignalsEvents. Audited.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
POST /admin-api/federation/signals-verify
verifyFederationSignalsStream
Ask the partner for a verification event
SSF 1.0 section 8.1.4.2: its state is checked when the event arrives.
Mirrors POST /admin/federation 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 |
|---|---|---|---|
id |
string | yes | The relationship. |
200: The relationship’s Shared Signals as they stand.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |
400: The operation was refused; errors says why and nothing changed.
| Member | Type | Required | What it is |
|---|---|---|---|
answer |
any JSON | The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. The partner’s own answer to an SSF stream management call (SSF 1.0 section 8), relayed as it arrived; null when it sent none. | |
errors |
list | ||
errors[] |
string | ||
message |
string | ||
ok |
boolean | yes | |
polled |
object | ||
polled.acted |
integer | ||
polled.received |
integer | ||
polled.refused |
integer | ||
polled.rounds |
integer | ||
polled.why |
string | ||
signals |
object | ||
signals.blocks |
list | ||
signals.blocks[].at |
string | ||
signals.blocks[].by |
string | ||
signals.blocks[].event |
string | ||
signals.blocks[].jti |
string | ||
signals.blocks[].relationship |
string | ||
signals.blocks[].username |
string | ||
signals.config |
object | ||
signals.config.add_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.configuration_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.delivery_methods_supported |
list | ||
signals.config.delivery_methods_supported[] |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.issuer |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.jwks_uri |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.remove_subject_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.status_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.config.verification_endpoint |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.counts |
object | ||
signals.counts.acted |
integer | ||
signals.counts.received |
integer | ||
signals.counts.refused |
integer | ||
signals.counts.verified |
integer | ||
signals.credential |
object | ||
signals.credential.clientId |
string | ||
signals.credential.method |
string | ||
signals.credential.scope |
string | ||
signals.credential.secretHeld |
boolean | ||
signals.credential.tokenEndpoint |
string | ||
signals.delivery |
string | ||
signals.discoveredAt |
string | ||
signals.discoveryUrl |
string | ||
signals.enabled |
boolean | ||
signals.eventsRequested |
list | ||
signals.eventsRequested[] |
string | ||
signals.issuer |
string | ||
signals.kind |
string | ||
signals.lastError |
string | ||
signals.lastPollAt |
string | ||
signals.lastPollResult |
string | ||
signals.missing |
list | ||
signals.missing[] |
string | ||
signals.name |
string | ||
signals.pollEndpoint |
string | ||
signals.pushEndpoint |
string | ||
signals.pushEndpointSet |
boolean | ||
signals.ready |
boolean | ||
signals.receiving |
boolean | ||
signals.relationship |
string | ||
signals.signalsEnabled |
boolean | ||
signals.state |
string | ||
signals.stream |
object | ||
signals.stream.aud |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery |
object | ||
signals.stream.delivery.endpoint_url |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.delivery.method |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_delivered |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_requested |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.events_supported |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.stream.stream_id |
any JSON | A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. A value of a document a partner published or answered, kept and relayed as it arrived: nothing here narrows it, and a partner’s odd value must not turn an operator’s own page into a failure. | |
signals.streamAud |
list | ||
signals.streamAud[] |
string | ||
signals.streamDelivery |
string | ||
signals.streamId |
string | ||
signals.streamStatus |
string | ||
signals.verifiedAt |
string |