Management API

The SCIM 2.0 provisioning endpoints under /scim/v2 — what they have been asked to do, and what they will and will not do. READ-ONLY here, and that is the parity rule holding rather than a gap: the console page has no form on it either, because everything about SCIM that can be changed is a configuration row. What SCIM WROTE is under Users and Groups, since it provisions into the same directory and has no store of its own.

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/scim

getScim

The SCIM 2.0 provisioning surface, and what it has been asked to do

Counters and capabilities in one reply. The counters say which SCIM operation was performed how many times, on which resource type, and what was refused with which scimType; every operation and resource type is listed INCLUDING the ones at zero, because “does this server do PATCH” is otherwise answered by omission. The capabilities say what the endpoints are, what SCIM here deliberately does not do, and which LDAP attribute each SCIM member is.

THERE IS NO POST BESIDE THIS ONE and that is not a gap: everything about SCIM that can be changed is a configuration row — scim.enabled, the three limits and the authentication settings — so POST /admin-api/config/set is already the operation for it. The console page has no form on it either, which is the parity rule holding rather than being broken.

WHAT SCIM WROTE is not here: it went into the embedded directory, so a person provisioned over SCIM is on /admin-api/users and their groups are on /admin-api/groups. There is no second store to report.

Mirrors GET /admin/scim 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
client query string   One outbound SCIM client’s identifier (#552): scimClients.client is then that client’s page — its queues, dead letters and discovery.
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 counters and the capabilities.

Member Type Required What it is
authentication object    
authentication.digestAlgorithms list    
authentication.digestAlgorithms[] string    
authentication.discoveryOpen boolean    
authentication.hobaRegistration string    
authentication.policy list    
authentication.policy[] string    
authentication.realm string    
authentication.required boolean    
authentication.schemes list    
authentication.schemes[].applicationScoped boolean    
authentication.schemes[].canonical boolean    
authentication.schemes[].challenged boolean    
authentication.schemes[].description string    
authentication.schemes[].enabled boolean    
authentication.schemes[].id string    
authentication.schemes[].name string    
authentication.schemes[].primary boolean    
authentication.schemes[].recorded boolean    
authentication.schemes[].refusedByMode string    
authentication.schemes[].scoped boolean    
authentication.schemes[].setting string    
authentication.schemes[].spec string    
authentication.schemes[].specUri string    
authentication.schemes[].type string    
authentication.scopes object    
authentication.scopes.read string    
authentication.scopes.write string    
baseUrl string, or null    
counters object    
counters.byAuthScheme map   A count per name.
counters.byAuthScheme.{key} number    
counters.byScimType map   A count per name.
counters.byScimType.{key} number    
counters.byStatus map   A count per name.
counters.byStatus.{key} number    
counters.failed number    
counters.firstAt number, or string, or null    
counters.lastAt number, or string, or null    
counters.ok number    
counters.operations list    
counters.operations[].count number    
counters.operations[].label string    
counters.operations[].method string    
counters.operations[].operation string    
counters.operations[].what string    
counters.resourceTypes list    
counters.resourceTypes[].count number    
counters.resourceTypes[].resourceType string, or null    
counters.total number    
doesNotDo list    
doesNotDo[] string    
enabled boolean    
endpoints list    
endpoints[].method string    
endpoints[].path string    
endpoints[].what string    
identifiers object    
identifiers.example string    
identifiers.id string    
identifiers.why string    
installed boolean    
mapping object    
mapping.group list    
mapping.group[].extension boolean    
mapping.group[].kind string, or null    
mapping.group[].ldap string, or null    
mapping.group[].note string    
mapping.group[].parent string, or null    
mapping.group[].readOnly boolean    
mapping.group[].required boolean    
mapping.group[].schema string    
mapping.group[].scim string    
mapping.group[].type string, or null    
mapping.user list    
mapping.user[].extension boolean    
mapping.user[].kind string, or null    
mapping.user[].ldap string, or null    
mapping.user[].note string    
mapping.user[].parent string, or null    
mapping.user[].readOnly boolean    
mapping.user[].required boolean    
mapping.user[].schema string    
mapping.user[].scim string    
mapping.user[].type string, or null    
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    
reachableNegatives list    
reachableNegatives[].answer string    
reachableNegatives[].what string    
scimClients object    
scimClients.cellId string, or null    
scimClients.choices object    
scimClients.choices.authMethods list    
scimClients.choices.authMethods[] string    
scimClients.choices.deprovision list    
scimClients.choices.deprovision[] string    
scimClients.choices.groupModes list    
scimClients.choices.groupModes[] string    
scimClients.choices.oauthClientAuth list    
scimClients.choices.oauthClientAuth[] string    
scimClients.choices.scopeModes list    
scimClients.choices.scopeModes[] string    
scimClients.choices.tlsSources list    
scimClients.choices.tlsSources[] string    
scimClients.client object    
scimClients.client.authMethod string    
scimClients.client.baseUrl string    
scimClients.client.byCell list    
scimClients.client.byCell[].cell string    
scimClients.client.byCell[].counts object    
scimClients.client.byCell[].counts.dead number    
scimClients.client.byCell[].counts.queued number    
scimClients.client.byCell[].counts.retrying number    
scimClients.client.byCell[].counts.sent number    
scimClients.client.byCell[].dead list    
scimClients.client.byCell[].dead[].attempts number, or null    
scimClients.client.byCell[].dead[].client string    
scimClients.client.byCell[].dead[].clientId string    
scimClients.client.byCell[].dead[].errorCode string, or null    
scimClients.client.byCell[].dead[].finishedAt string    
scimClients.client.byCell[].dead[].generation number, or null    
scimClients.client.byCell[].dead[].holder string    
scimClients.client.byCell[].dead[].id string    
scimClients.client.byCell[].dead[].inFlight boolean    
scimClients.client.byCell[].dead[].lastAttemptAt string    
scimClients.client.byCell[].dead[].name string    
scimClients.client.byCell[].dead[].nextAttemptAt string    
scimClients.client.byCell[].dead[].pendingChange boolean    
scimClients.client.byCell[].dead[].queuedAt string    
scimClients.client.byCell[].dead[].realm string, or null    
scimClients.client.byCell[].dead[].state string    
scimClients.client.byCell[].dead[].status number, or string, or null    
scimClients.client.byCell[].dead[].type string    
scimClients.client.byCell[].dead[].uri string, or null    
scimClients.client.byCell[].dead[].uuid string    
scimClients.client.byCell[].dead[].why string, or null    
scimClients.client.byCell[].error string    
scimClients.client.byCell[].failures number    
scimClients.client.byCell[].here boolean    
scimClients.client.byCell[].identifier string    
scimClients.client.byCell[].lastReconcileAt string    
scimClients.client.byCell[].pausedUntil string    
scimClients.client.byCell[].pushes boolean    
scimClients.client.byCell[].queued list    
scimClients.client.byCell[].queued[].attempts number, or null    
scimClients.client.byCell[].queued[].client string    
scimClients.client.byCell[].queued[].clientId string    
scimClients.client.byCell[].queued[].errorCode string, or null    
scimClients.client.byCell[].queued[].finishedAt string    
scimClients.client.byCell[].queued[].generation number, or null    
scimClients.client.byCell[].queued[].holder string    
scimClients.client.byCell[].queued[].id string    
scimClients.client.byCell[].queued[].inFlight boolean    
scimClients.client.byCell[].queued[].lastAttemptAt string    
scimClients.client.byCell[].queued[].name string    
scimClients.client.byCell[].queued[].nextAttemptAt string    
scimClients.client.byCell[].queued[].pendingChange boolean    
scimClients.client.byCell[].queued[].queuedAt string    
scimClients.client.byCell[].queued[].realm string, or null    
scimClients.client.byCell[].queued[].state string    
scimClients.client.byCell[].queued[].status number, or string, or null    
scimClients.client.byCell[].queued[].type string    
scimClients.client.byCell[].queued[].uri string, or null    
scimClients.client.byCell[].queued[].uuid string    
scimClients.client.byCell[].queued[].why string, or null    
scimClients.client.byCell[].reachable boolean    
scimClients.client.byCell[].retrying list    
scimClients.client.byCell[].retrying[].attempts number, or null    
scimClients.client.byCell[].retrying[].client string    
scimClients.client.byCell[].retrying[].clientId string    
scimClients.client.byCell[].retrying[].errorCode string, or null    
scimClients.client.byCell[].retrying[].finishedAt string    
scimClients.client.byCell[].retrying[].generation number, or null    
scimClients.client.byCell[].retrying[].holder string    
scimClients.client.byCell[].retrying[].id string    
scimClients.client.byCell[].retrying[].inFlight boolean    
scimClients.client.byCell[].retrying[].lastAttemptAt string    
scimClients.client.byCell[].retrying[].name string    
scimClients.client.byCell[].retrying[].nextAttemptAt string    
scimClients.client.byCell[].retrying[].pendingChange boolean    
scimClients.client.byCell[].retrying[].queuedAt string    
scimClients.client.byCell[].retrying[].realm string, or null    
scimClients.client.byCell[].retrying[].state string    
scimClients.client.byCell[].retrying[].status number, or string, or null    
scimClients.client.byCell[].retrying[].type string    
scimClients.client.byCell[].retrying[].uri string, or null    
scimClients.client.byCell[].retrying[].uuid string    
scimClients.client.byCell[].retrying[].why string, or null    
scimClients.client.byCell[].withheld string    
scimClients.client.caCertificates string    
scimClients.client.cells list    
scimClients.client.cells[] string    
scimClients.client.certificate object    
scimClients.client.certificate.error string    
scimClients.client.certificate.issuer string    
scimClients.client.certificate.notAfter string, or null    
scimClients.client.certificate.serial string, or null    
scimClients.client.certificate.subject string    
scimClients.client.counts object    
scimClients.client.counts.dead number    
scimClients.client.counts.queued number    
scimClients.client.counts.retrying number    
scimClients.client.counts.sent number    
scimClients.client.deprovision string    
scimClients.client.discovery object    
scimClients.client.discovery.at string    
scimClients.client.discovery.authenticationSchemes list    
scimClients.client.discovery.authenticationSchemes[] string    
scimClients.client.discovery.bulk boolean    
scimClients.client.discovery.endpoints map   The path of each resource type, by its name.
scimClients.client.discovery.endpoints.{key} string    
scimClients.client.discovery.etag boolean    
scimClients.client.discovery.filter boolean    
scimClients.client.discovery.maxResults number    
scimClients.client.discovery.ok boolean    
scimClients.client.discovery.patch boolean    
scimClients.client.discovery.why string    
scimClients.client.dn string    
scimClients.client.enabled boolean    
scimClients.client.failures number    
scimClients.client.groupMode string    
scimClients.client.groups list    
scimClients.client.groups[] string    
scimClients.client.id string    
scimClients.client.identifier string    
scimClients.client.jurisdiction string    
scimClients.client.lastReconcile object    
scimClients.client.lastReconcile.deprovisioned number    
scimClients.client.lastReconcile.groups number    
scimClients.client.lastReconcile.notPushedHere boolean    
scimClients.client.lastReconcile.ok boolean    
scimClients.client.lastReconcile.users number    
scimClients.client.lastReconcile.why string    
scimClients.client.lastReconcileAt string    
scimClients.client.linked number    
scimClients.client.maxRequestsPerSecond string    
scimClients.client.name string    
scimClients.client.oauthClientAuth string    
scimClients.client.oauthClientId string    
scimClients.client.oauthClientSecretSet boolean    
scimClients.client.oauthResource string    
scimClients.client.oauthScope string    
scimClients.client.passwordSet boolean    
scimClients.client.pausedUntil string    
scimClients.client.problems list    
scimClients.client.problems[] string    
scimClients.client.queues object    
scimClients.client.queues.counts object    
scimClients.client.queues.counts.dead number    
scimClients.client.queues.counts.queued number    
scimClients.client.queues.counts.retrying number    
scimClients.client.queues.counts.sent number    
scimClients.client.queues.dead list    
scimClients.client.queues.dead[].attempts number, or null    
scimClients.client.queues.dead[].client string    
scimClients.client.queues.dead[].clientId string    
scimClients.client.queues.dead[].errorCode string, or null    
scimClients.client.queues.dead[].finishedAt string    
scimClients.client.queues.dead[].generation number, or null    
scimClients.client.queues.dead[].holder string    
scimClients.client.queues.dead[].id string    
scimClients.client.queues.dead[].inFlight boolean    
scimClients.client.queues.dead[].lastAttemptAt string    
scimClients.client.queues.dead[].name string    
scimClients.client.queues.dead[].nextAttemptAt string    
scimClients.client.queues.dead[].pendingChange boolean    
scimClients.client.queues.dead[].queuedAt string    
scimClients.client.queues.dead[].realm string, or null    
scimClients.client.queues.dead[].state string    
scimClients.client.queues.dead[].status number, or string, or null    
scimClients.client.queues.dead[].type string    
scimClients.client.queues.dead[].uri string, or null    
scimClients.client.queues.dead[].uuid string    
scimClients.client.queues.dead[].why string, or null    
scimClients.client.queues.queued list    
scimClients.client.queues.queued[].attempts number, or null    
scimClients.client.queues.queued[].client string    
scimClients.client.queues.queued[].clientId string    
scimClients.client.queues.queued[].errorCode string, or null    
scimClients.client.queues.queued[].finishedAt string    
scimClients.client.queues.queued[].generation number, or null    
scimClients.client.queues.queued[].holder string    
scimClients.client.queues.queued[].id string    
scimClients.client.queues.queued[].inFlight boolean    
scimClients.client.queues.queued[].lastAttemptAt string    
scimClients.client.queues.queued[].name string    
scimClients.client.queues.queued[].nextAttemptAt string    
scimClients.client.queues.queued[].pendingChange boolean    
scimClients.client.queues.queued[].queuedAt string    
scimClients.client.queues.queued[].realm string, or null    
scimClients.client.queues.queued[].state string    
scimClients.client.queues.queued[].status number, or string, or null    
scimClients.client.queues.queued[].type string    
scimClients.client.queues.queued[].uri string, or null    
scimClients.client.queues.queued[].uuid string    
scimClients.client.queues.queued[].why string, or null    
scimClients.client.queues.retrying list    
scimClients.client.queues.retrying[].attempts number, or null    
scimClients.client.queues.retrying[].client string    
scimClients.client.queues.retrying[].clientId string    
scimClients.client.queues.retrying[].errorCode string, or null    
scimClients.client.queues.retrying[].finishedAt string    
scimClients.client.queues.retrying[].generation number, or null    
scimClients.client.queues.retrying[].holder string    
scimClients.client.queues.retrying[].id string    
scimClients.client.queues.retrying[].inFlight boolean    
scimClients.client.queues.retrying[].lastAttemptAt string    
scimClients.client.queues.retrying[].name string    
scimClients.client.queues.retrying[].nextAttemptAt string    
scimClients.client.queues.retrying[].pendingChange boolean    
scimClients.client.queues.retrying[].queuedAt string    
scimClients.client.queues.retrying[].realm string, or null    
scimClients.client.queues.retrying[].state string    
scimClients.client.queues.retrying[].status number, or string, or null    
scimClients.client.queues.retrying[].type string    
scimClients.client.queues.retrying[].uri string, or null    
scimClients.client.queues.retrying[].uuid string    
scimClients.client.queues.retrying[].why string, or null    
scimClients.client.reconcileMinutes string    
scimClients.client.scopeFilter string    
scimClients.client.scopeGroups list    
scimClients.client.scopeGroups[] string    
scimClients.client.scopeMode string    
scimClients.client.tlsCertificate string    
scimClients.client.tlsPrivateKeySet boolean    
scimClients.client.tlsSource string    
scimClients.client.tokenEndpoint string    
scimClients.client.usable boolean    
scimClients.client.username string    
scimClients.clients list    
scimClients.clients[].authMethod string    
scimClients.clients[].baseUrl string    
scimClients.clients[].byCell list    
scimClients.clients[].byCell[].cell string    
scimClients.clients[].byCell[].counts object    
scimClients.clients[].byCell[].counts.dead number    
scimClients.clients[].byCell[].counts.queued number    
scimClients.clients[].byCell[].counts.retrying number    
scimClients.clients[].byCell[].counts.sent number    
scimClients.clients[].byCell[].dead list    
scimClients.clients[].byCell[].dead[].attempts number, or null    
scimClients.clients[].byCell[].dead[].client string    
scimClients.clients[].byCell[].dead[].clientId string    
scimClients.clients[].byCell[].dead[].errorCode string, or null    
scimClients.clients[].byCell[].dead[].finishedAt string    
scimClients.clients[].byCell[].dead[].generation number, or null    
scimClients.clients[].byCell[].dead[].holder string    
scimClients.clients[].byCell[].dead[].id string    
scimClients.clients[].byCell[].dead[].inFlight boolean    
scimClients.clients[].byCell[].dead[].lastAttemptAt string    
scimClients.clients[].byCell[].dead[].name string    
scimClients.clients[].byCell[].dead[].nextAttemptAt string    
scimClients.clients[].byCell[].dead[].pendingChange boolean    
scimClients.clients[].byCell[].dead[].queuedAt string    
scimClients.clients[].byCell[].dead[].realm string, or null    
scimClients.clients[].byCell[].dead[].state string    
scimClients.clients[].byCell[].dead[].status number, or string, or null    
scimClients.clients[].byCell[].dead[].type string    
scimClients.clients[].byCell[].dead[].uri string, or null    
scimClients.clients[].byCell[].dead[].uuid string    
scimClients.clients[].byCell[].dead[].why string, or null    
scimClients.clients[].byCell[].error string    
scimClients.clients[].byCell[].failures number    
scimClients.clients[].byCell[].here boolean    
scimClients.clients[].byCell[].identifier string    
scimClients.clients[].byCell[].lastReconcileAt string    
scimClients.clients[].byCell[].pausedUntil string    
scimClients.clients[].byCell[].pushes boolean    
scimClients.clients[].byCell[].queued list    
scimClients.clients[].byCell[].queued[].attempts number, or null    
scimClients.clients[].byCell[].queued[].client string    
scimClients.clients[].byCell[].queued[].clientId string    
scimClients.clients[].byCell[].queued[].errorCode string, or null    
scimClients.clients[].byCell[].queued[].finishedAt string    
scimClients.clients[].byCell[].queued[].generation number, or null    
scimClients.clients[].byCell[].queued[].holder string    
scimClients.clients[].byCell[].queued[].id string    
scimClients.clients[].byCell[].queued[].inFlight boolean    
scimClients.clients[].byCell[].queued[].lastAttemptAt string    
scimClients.clients[].byCell[].queued[].name string    
scimClients.clients[].byCell[].queued[].nextAttemptAt string    
scimClients.clients[].byCell[].queued[].pendingChange boolean    
scimClients.clients[].byCell[].queued[].queuedAt string    
scimClients.clients[].byCell[].queued[].realm string, or null    
scimClients.clients[].byCell[].queued[].state string    
scimClients.clients[].byCell[].queued[].status number, or string, or null    
scimClients.clients[].byCell[].queued[].type string    
scimClients.clients[].byCell[].queued[].uri string, or null    
scimClients.clients[].byCell[].queued[].uuid string    
scimClients.clients[].byCell[].queued[].why string, or null    
scimClients.clients[].byCell[].reachable boolean    
scimClients.clients[].byCell[].retrying list    
scimClients.clients[].byCell[].retrying[].attempts number, or null    
scimClients.clients[].byCell[].retrying[].client string    
scimClients.clients[].byCell[].retrying[].clientId string    
scimClients.clients[].byCell[].retrying[].errorCode string, or null    
scimClients.clients[].byCell[].retrying[].finishedAt string    
scimClients.clients[].byCell[].retrying[].generation number, or null    
scimClients.clients[].byCell[].retrying[].holder string    
scimClients.clients[].byCell[].retrying[].id string    
scimClients.clients[].byCell[].retrying[].inFlight boolean    
scimClients.clients[].byCell[].retrying[].lastAttemptAt string    
scimClients.clients[].byCell[].retrying[].name string    
scimClients.clients[].byCell[].retrying[].nextAttemptAt string    
scimClients.clients[].byCell[].retrying[].pendingChange boolean    
scimClients.clients[].byCell[].retrying[].queuedAt string    
scimClients.clients[].byCell[].retrying[].realm string, or null    
scimClients.clients[].byCell[].retrying[].state string    
scimClients.clients[].byCell[].retrying[].status number, or string, or null    
scimClients.clients[].byCell[].retrying[].type string    
scimClients.clients[].byCell[].retrying[].uri string, or null    
scimClients.clients[].byCell[].retrying[].uuid string    
scimClients.clients[].byCell[].retrying[].why string, or null    
scimClients.clients[].byCell[].withheld string    
scimClients.clients[].caCertificates string    
scimClients.clients[].cells list    
scimClients.clients[].cells[] string    
scimClients.clients[].certificate object    
scimClients.clients[].certificate.error string    
scimClients.clients[].certificate.issuer string    
scimClients.clients[].certificate.notAfter string, or null    
scimClients.clients[].certificate.serial string, or null    
scimClients.clients[].certificate.subject string    
scimClients.clients[].counts object    
scimClients.clients[].counts.dead number    
scimClients.clients[].counts.queued number    
scimClients.clients[].counts.retrying number    
scimClients.clients[].counts.sent number    
scimClients.clients[].deprovision string    
scimClients.clients[].dn string    
scimClients.clients[].enabled boolean    
scimClients.clients[].failures number    
scimClients.clients[].groupMode string    
scimClients.clients[].groups list    
scimClients.clients[].groups[] string    
scimClients.clients[].id string    
scimClients.clients[].identifier string    
scimClients.clients[].jurisdiction string    
scimClients.clients[].lastReconcile object    
scimClients.clients[].lastReconcile.deprovisioned number    
scimClients.clients[].lastReconcile.groups number    
scimClients.clients[].lastReconcile.notPushedHere boolean    
scimClients.clients[].lastReconcile.ok boolean    
scimClients.clients[].lastReconcile.users number    
scimClients.clients[].lastReconcile.why string    
scimClients.clients[].lastReconcileAt string    
scimClients.clients[].maxRequestsPerSecond string    
scimClients.clients[].name string    
scimClients.clients[].oauthClientAuth string    
scimClients.clients[].oauthClientId string    
scimClients.clients[].oauthClientSecretSet boolean    
scimClients.clients[].oauthResource string    
scimClients.clients[].oauthScope string    
scimClients.clients[].passwordSet boolean    
scimClients.clients[].pausedUntil string    
scimClients.clients[].problems list    
scimClients.clients[].problems[] string    
scimClients.clients[].reconcileMinutes string    
scimClients.clients[].scopeFilter string    
scimClients.clients[].scopeGroups list    
scimClients.clients[].scopeGroups[] string    
scimClients.clients[].scopeMode string    
scimClients.clients[].tlsCertificate string    
scimClients.clients[].tlsPrivateKeySet boolean    
scimClients.clients[].tlsSource string    
scimClients.clients[].tokenEndpoint string    
scimClients.clients[].usable boolean    
scimClients.clients[].username string    
scimClients.family string    
scimClients.httpAllowed boolean    
scimClients.missing string    
settings object    
settings.context object    
settings.context.configFile string, or null    
settings.context.defaultsFile string, or null    
settings.context.inRealm boolean    
settings.context.persistenceMode string    
settings.context.persistsAppconfig boolean    
settings.context.persistsRealms boolean    
settings.context.realmId string, or null    
settings.editableCount integer    
settings.groups list    
settings.groups[].group string    
settings.groups[].settings list    
settings.groups[].settings[].appconfigPath string    
settings.groups[].settings[].csvValueNotes map   The sentence beside each value.
settings.groups[].settings[].csvValueNotes.{key} string    
settings.groups[].settings[].csvValues list    
settings.groups[].settings[].csvValues[] string    
settings.groups[].settings[].default list, or boolean, or number, or string, or null    
settings.groups[].settings[].default[] string    
settings.groups[].settings[].description string    
settings.groups[].settings[].editRefusal string    
settings.groups[].settings[].editable boolean    
settings.groups[].settings[].enumValues list    
settings.groups[].settings[].enumValues[] string    
settings.groups[].settings[].env string, or null    
settings.groups[].settings[].group string    
settings.groups[].settings[].key string    
settings.groups[].settings[].label string    
settings.groups[].settings[].legacyEnv string, or null    
settings.groups[].settings[].masked boolean    
settings.groups[].settings[].max number    
settings.groups[].settings[].min number    
settings.groups[].settings[].ordered boolean    
settings.groups[].settings[].overridden boolean    
settings.groups[].settings[].realmSettable boolean    
settings.groups[].settings[].restartReason string    
settings.groups[].settings[].selectAll map   The rules by kind: onlyWhileOn and aloneWhileOn.
settings.groups[].settings[].selectAll.{key} list    
settings.groups[].settings[].selectAll.{key}[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].values object   Nested deeper than this page draws.
settings.groups[].settings[].source string    
settings.groups[].settings[].step number    
settings.groups[].settings[].text string, or null    
settings.groups[].settings[].type string    
settings.groups[].settings[].value list, or boolean, or number, or string, or null    
settings.groups[].settings[].value[] string    
settings.overridden list    
settings.overridden[] string    
settings.page string    
settings.setWith string    
settings.settingCount integer    
settings.sharedWith map   The other pages, by settings group.
settings.sharedWith.{key} list    
settings.sharedWith.{key}[].label string    
settings.sharedWith.{key}[].path string    
specifications list    
specifications[] string    
store object    
store.baseDn string    
store.entryCount number    
store.groupCount number    
store.groups string    
store.maxEntries number    
store.userCount number    
store.users string    
store.what string    

GET /admin-api/scim/clients

getScimClients

This realm’s outbound SCIM clients (#552)

Everything Protocols → SCIM → Clients draws: each client (an application entry declared for the scim-client family) with its service provider, authentication, scope, whether it is usable and why not, its queue counts (queued, retrying, dead, sent) and its backoff pause. With client, that client’s page too: its retry queue and dead letters, what its service provider’s discovery said, and how many resources it has linked. In a service deployed as cells (#553) each client and the page carry byCell: every cell’s counts, pause and — on the page, where the issuance policy releases them — queues, a cell that cannot be reached listed reachable: false. NEVER a credential.

Mirrors GET /admin/scim 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
client query string   One client’s identifier, for its page.
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 clients.

Member Type Required What it is
cellId string, or null    
choices object    
choices.authMethods list    
choices.authMethods[] string    
choices.deprovision list    
choices.deprovision[] string    
choices.groupModes list    
choices.groupModes[] string    
choices.oauthClientAuth list    
choices.oauthClientAuth[] string    
choices.scopeModes list    
choices.scopeModes[] string    
choices.tlsSources list    
choices.tlsSources[] string    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].errorCode string, or null    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].errorCode string, or null    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].errorCode string, or null    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.discovery object    
client.discovery.at string    
client.discovery.authenticationSchemes list    
client.discovery.authenticationSchemes[] string    
client.discovery.bulk boolean    
client.discovery.endpoints map   The path of each resource type, by its name.
client.discovery.endpoints.{key} string    
client.discovery.etag boolean    
client.discovery.filter boolean    
client.discovery.maxResults number    
client.discovery.ok boolean    
client.discovery.patch boolean    
client.discovery.why string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.linked number    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.queues object    
client.queues.counts object    
client.queues.counts.dead number    
client.queues.counts.queued number    
client.queues.counts.retrying number    
client.queues.counts.sent number    
client.queues.dead list    
client.queues.dead[].attempts number, or null    
client.queues.dead[].client string    
client.queues.dead[].clientId string    
client.queues.dead[].errorCode string, or null    
client.queues.dead[].finishedAt string    
client.queues.dead[].generation number, or null    
client.queues.dead[].holder string    
client.queues.dead[].id string    
client.queues.dead[].inFlight boolean    
client.queues.dead[].lastAttemptAt string    
client.queues.dead[].name string    
client.queues.dead[].nextAttemptAt string    
client.queues.dead[].pendingChange boolean    
client.queues.dead[].queuedAt string    
client.queues.dead[].realm string, or null    
client.queues.dead[].state string    
client.queues.dead[].status number, or string, or null    
client.queues.dead[].type string    
client.queues.dead[].uri string, or null    
client.queues.dead[].uuid string    
client.queues.dead[].why string, or null    
client.queues.queued list    
client.queues.queued[].attempts number, or null    
client.queues.queued[].client string    
client.queues.queued[].clientId string    
client.queues.queued[].errorCode string, or null    
client.queues.queued[].finishedAt string    
client.queues.queued[].generation number, or null    
client.queues.queued[].holder string    
client.queues.queued[].id string    
client.queues.queued[].inFlight boolean    
client.queues.queued[].lastAttemptAt string    
client.queues.queued[].name string    
client.queues.queued[].nextAttemptAt string    
client.queues.queued[].pendingChange boolean    
client.queues.queued[].queuedAt string    
client.queues.queued[].realm string, or null    
client.queues.queued[].state string    
client.queues.queued[].status number, or string, or null    
client.queues.queued[].type string    
client.queues.queued[].uri string, or null    
client.queues.queued[].uuid string    
client.queues.queued[].why string, or null    
client.queues.retrying list    
client.queues.retrying[].attempts number, or null    
client.queues.retrying[].client string    
client.queues.retrying[].clientId string    
client.queues.retrying[].errorCode string, or null    
client.queues.retrying[].finishedAt string    
client.queues.retrying[].generation number, or null    
client.queues.retrying[].holder string    
client.queues.retrying[].id string    
client.queues.retrying[].inFlight boolean    
client.queues.retrying[].lastAttemptAt string    
client.queues.retrying[].name string    
client.queues.retrying[].nextAttemptAt string    
client.queues.retrying[].pendingChange boolean    
client.queues.retrying[].queuedAt string    
client.queues.retrying[].realm string, or null    
client.queues.retrying[].state string    
client.queues.retrying[].status number, or string, or null    
client.queues.retrying[].type string    
client.queues.retrying[].uri string, or null    
client.queues.retrying[].uuid string    
client.queues.retrying[].why string, or null    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
clients list    
clients[].authMethod string    
clients[].baseUrl string    
clients[].byCell list    
clients[].byCell[].cell string    
clients[].byCell[].counts object    
clients[].byCell[].counts.dead number    
clients[].byCell[].counts.queued number    
clients[].byCell[].counts.retrying number    
clients[].byCell[].counts.sent number    
clients[].byCell[].dead list    
clients[].byCell[].dead[].attempts number, or null    
clients[].byCell[].dead[].client string    
clients[].byCell[].dead[].clientId string    
clients[].byCell[].dead[].errorCode string, or null    
clients[].byCell[].dead[].finishedAt string    
clients[].byCell[].dead[].generation number, or null    
clients[].byCell[].dead[].holder string    
clients[].byCell[].dead[].id string    
clients[].byCell[].dead[].inFlight boolean    
clients[].byCell[].dead[].lastAttemptAt string    
clients[].byCell[].dead[].name string    
clients[].byCell[].dead[].nextAttemptAt string    
clients[].byCell[].dead[].pendingChange boolean    
clients[].byCell[].dead[].queuedAt string    
clients[].byCell[].dead[].realm string, or null    
clients[].byCell[].dead[].state string    
clients[].byCell[].dead[].status number, or string, or null    
clients[].byCell[].dead[].type string    
clients[].byCell[].dead[].uri string, or null    
clients[].byCell[].dead[].uuid string    
clients[].byCell[].dead[].why string, or null    
clients[].byCell[].error string    
clients[].byCell[].failures number    
clients[].byCell[].here boolean    
clients[].byCell[].identifier string    
clients[].byCell[].lastReconcileAt string    
clients[].byCell[].pausedUntil string    
clients[].byCell[].pushes boolean    
clients[].byCell[].queued list    
clients[].byCell[].queued[].attempts number, or null    
clients[].byCell[].queued[].client string    
clients[].byCell[].queued[].clientId string    
clients[].byCell[].queued[].errorCode string, or null    
clients[].byCell[].queued[].finishedAt string    
clients[].byCell[].queued[].generation number, or null    
clients[].byCell[].queued[].holder string    
clients[].byCell[].queued[].id string    
clients[].byCell[].queued[].inFlight boolean    
clients[].byCell[].queued[].lastAttemptAt string    
clients[].byCell[].queued[].name string    
clients[].byCell[].queued[].nextAttemptAt string    
clients[].byCell[].queued[].pendingChange boolean    
clients[].byCell[].queued[].queuedAt string    
clients[].byCell[].queued[].realm string, or null    
clients[].byCell[].queued[].state string    
clients[].byCell[].queued[].status number, or string, or null    
clients[].byCell[].queued[].type string    
clients[].byCell[].queued[].uri string, or null    
clients[].byCell[].queued[].uuid string    
clients[].byCell[].queued[].why string, or null    
clients[].byCell[].reachable boolean    
clients[].byCell[].retrying list    
clients[].byCell[].retrying[].attempts number, or null    
clients[].byCell[].retrying[].client string    
clients[].byCell[].retrying[].clientId string    
clients[].byCell[].retrying[].errorCode string, or null    
clients[].byCell[].retrying[].finishedAt string    
clients[].byCell[].retrying[].generation number, or null    
clients[].byCell[].retrying[].holder string    
clients[].byCell[].retrying[].id string    
clients[].byCell[].retrying[].inFlight boolean    
clients[].byCell[].retrying[].lastAttemptAt string    
clients[].byCell[].retrying[].name string    
clients[].byCell[].retrying[].nextAttemptAt string    
clients[].byCell[].retrying[].pendingChange boolean    
clients[].byCell[].retrying[].queuedAt string    
clients[].byCell[].retrying[].realm string, or null    
clients[].byCell[].retrying[].state string    
clients[].byCell[].retrying[].status number, or string, or null    
clients[].byCell[].retrying[].type string    
clients[].byCell[].retrying[].uri string, or null    
clients[].byCell[].retrying[].uuid string    
clients[].byCell[].retrying[].why string, or null    
clients[].byCell[].withheld string    
clients[].caCertificates string    
clients[].cells list    
clients[].cells[] string    
clients[].certificate object    
clients[].certificate.error string    
clients[].certificate.issuer string    
clients[].certificate.notAfter string, or null    
clients[].certificate.serial string, or null    
clients[].certificate.subject string    
clients[].counts object    
clients[].counts.dead number    
clients[].counts.queued number    
clients[].counts.retrying number    
clients[].counts.sent number    
clients[].deprovision string    
clients[].dn string    
clients[].enabled boolean    
clients[].failures number    
clients[].groupMode string    
clients[].groups list    
clients[].groups[] string    
clients[].id string    
clients[].identifier string    
clients[].jurisdiction string    
clients[].lastReconcile object    
clients[].lastReconcile.deprovisioned number    
clients[].lastReconcile.groups number    
clients[].lastReconcile.notPushedHere boolean    
clients[].lastReconcile.ok boolean    
clients[].lastReconcile.users number    
clients[].lastReconcile.why string    
clients[].lastReconcileAt string    
clients[].maxRequestsPerSecond string    
clients[].name string    
clients[].oauthClientAuth string    
clients[].oauthClientId string    
clients[].oauthClientSecretSet boolean    
clients[].oauthResource string    
clients[].oauthScope string    
clients[].passwordSet boolean    
clients[].pausedUntil string    
clients[].problems list    
clients[].problems[] string    
clients[].reconcileMinutes string    
clients[].scopeFilter string    
clients[].scopeGroups list    
clients[].scopeGroups[] string    
clients[].scopeMode string    
clients[].tlsCertificate string    
clients[].tlsPrivateKeySet boolean    
clients[].tlsSource string    
clients[].tokenEndpoint string    
clients[].usable boolean    
clients[].username string    
family string    
httpAllowed boolean    
missing 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    

POST /admin-api/scim/clients/add-client

addScimClient

Add an outbound SCIM client

Creates an application entry declared for the scim-client family, with its service provider, its authentication (credentials sealed and write-only), who and which groups it pushes, and what deprovisioning means. Refused for a base URI that is not https or carries a user name or a query, a closed-set value outside its set, an LDAP filter that does not parse, or certificates that do not. A new client is off until enabled is true. Audited, without a credential.

Mirrors POST /admin/scim 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
authMethod one of basic, oauth2, none   basic, oauth2 (client_credentials), or none (only with a TLS client certificate).
baseUrl string   The service provider’s SCIM base URI (RFC 7644 section 1.3): https, no user name, no query.
caCertificates string   PEM certificates trusted for the service provider beside the public roots.
cells list, or string    
cells[] string    
deprovision one of deactivate, delete   What leaving the scope does there: deactivate (active false) or delete.
enabled one of true, false   Whether changes are pushed. A new client is off until this says true.
groupMode one of none, selected, member-groups, all   Which groups are pushed: none, selected, member-groups or all.
groups list, or string    
groups[] string    
identifier string yes The client’s application identifier (add only): the entry it is filed under in ou=applications.
jurisdiction string   A service deployed as cells (#553): the jurisdiction the service provider is in, as the cell map spells one (us, eu, ca). Each person’s home cell asks the issuance policy (release-attributes, purpose scim-provision) before pushing them there; a refusal leaves them out of scope. Empty is unknown, which the strict default never releases to. Ignored in a service that is one cell.
maxRequestsPerSecond string   The most requests a second the service provider is sent; every request waits for its turn rather than failing. Empty or 0 is no limit. In a service deployed as cells each pushing cell may send this divided by the pushing cells, rounded up (#553).
name string   What to call it on a page.
oauthClientAuth one of client_secret_basic, client_secret_post   oauth2: how the client authenticates at the token endpoint.
oauthClientId string   oauth2: the client_id.
oauthClientSecret string   oauth2: the client secret, write-only.
oauthResource string   oauth2: an RFC 8707 resource, if any.
oauthScope string   oauth2: the scope asked for, if any.
password string   basic: the password, write-only. On a change, empty keeps the one set.
reconcileMinutes string   Minutes between scheduled reconciliations; 0 is on demand only.
scopeFilter string   filter: an RFC 4515 LDAP filter.
scopeGroups list, or string    
scopeGroups[] string    
scopeMode one of all, groups, filter   Who is pushed: all, groups, or filter.
tlsCertificate string   uploaded: the PEM certificate and its chain.
tlsPrivateKey string   uploaded: the PEM private key, write-only.
tlsSource one of none, issued, uploaded   The TLS client certificate: none, issued (issue-certificate) or uploaded.
tokenEndpoint string   oauth2: the token endpoint.
username string   basic: the user name.

200: The client as the register now answers it.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/deliver-now

deliverScimClientNow

Lift the client’s pause and send its queue

Ends the backoff pause and makes every queued and retrying delivery due now. Use it once the service provider is answering again. In a service deployed as cells the pause is every cell’s and is lifted for all; cell sends the queue of that cell only (#553).

Mirrors POST /admin/scim 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
cell string   A service deployed as cells (#553): the cell the act is sent to. Without it the act goes to every cell that pushes to the client, and the answer lists each cell’s result. Refused in a service that is one cell.
id string yes The client: its identifier or its entry’s DN.

200: ok.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/issue-certificate

issueScimClientCertificate

Issue the client a TLS client certificate

Issues a clientAuth certificate from this realm’s tls-client Issuing CA to the client’s application entry, and makes it the certificate the client presents (source issued). The private key is sealed on the entry and never returned; the service provider must trust the service Root. Audited.

Mirrors POST /admin/scim 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 client: its identifier or its entry’s DN.

200: The certificate’s subject, serial and expiry, and the service Root.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/purge-dead

purgeScimDeadLetters

Purge a client’s dead letters

Deletes every dead letter of the client. The next change to each resource, or a reconciliation, queues it afresh. Audited. In a service deployed as cells, in the cell cell names, or in every cell (#553).

Mirrors POST /admin/scim 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
cell string   A service deployed as cells (#553): the cell the act is sent to. Without it the act goes to every cell that pushes to the client, and the answer lists each cell’s result. Refused in a service that is one cell.
id string yes The client: its identifier or its entry’s DN.

200: How many were purged.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/reconcile

reconcileScimClient

Reconcile the client now

Queues every person and group in the client’s scope, and every resource its service provider holds under an externalId of this realm’s that is no longer in scope; then sends what is due. Audited. In a service deployed as cells each cell reconciles the people homed there: cell sends it to that cell, and without it every cell reconciles, each cell’s result listed in cells (#553).

Mirrors POST /admin/scim 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
cell string   A service deployed as cells (#553): the cell the act is sent to. Without it the act goes to every cell that pushes to the client, and the answer lists each cell’s result. Refused in a service that is one cell.
id string yes The client: its identifier or its entry’s DN.

200: How many users and groups were queued, and how many to deprovision.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/remove-client

removeScimClient

Remove an outbound SCIM client

Deletes its application entry, credentials and all, with its queues, links and backoff state. Nothing at the service provider changes. Audited.

Mirrors POST /admin/scim 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 client: its identifier or its entry’s DN.

200: What was removed.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/retry-dead

retryScimDeadLetters

Retry every dead letter of a client

Queues every dead letter of the client again. Audited. In a service deployed as cells, in the cell cell names, or in every cell (#553).

Mirrors POST /admin/scim 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
cell string   A service deployed as cells (#553): the cell the act is sent to. Without it the act goes to every cell that pushes to the client, and the answer lists each cell’s result. Refused in a service that is one cell.
id string yes The client: its identifier or its entry’s DN.

200: How many were queued.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/retry-delivery

retryScimDelivery

Retry one dead letter

Queues one dead letter again, by its row id (<client>|User|<uuid> or <client>|Group|<uuid>); it sends the resource as it is now. Audited. In a service deployed as cells the row is in the cell cell names; without one every cell retries the row of that id it holds (#553).

Mirrors POST /admin/scim 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
cell string   A service deployed as cells (#553): the cell the act is sent to. Without it the act goes to every cell that pushes to the client, and the answer lists each cell’s result. Refused in a service that is one cell.
id string yes The delivery row’s id.

200: ok, or a coded refusal.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/test-connection

testScimClient

Read the service provider’s configuration

Reads /ServiceProviderConfig and /ResourceTypes afresh and lists one User, with the client’s own authentication. Writes nothing there.

Mirrors POST /admin/scim 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 client: its identifier or its entry’s DN.

200: What discovery said, or a coded refusal.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

POST /admin-api/scim/clients/update-client

updateScimClient

Change an outbound SCIM client

The members given replace the client’s; the rest are kept, each credential included when none is given. Checked as add-client is. Forgets this process’s discovery and token. Audited, without a credential.

Mirrors POST /admin/scim 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
authMethod one of basic, oauth2, none   basic, oauth2 (client_credentials), or none (only with a TLS client certificate).
baseUrl string   The service provider’s SCIM base URI (RFC 7644 section 1.3): https, no user name, no query.
caCertificates string   PEM certificates trusted for the service provider beside the public roots.
cells list, or string    
cells[] string    
deprovision one of deactivate, delete   What leaving the scope does there: deactivate (active false) or delete.
enabled one of true, false   Whether changes are pushed. A new client is off until this says true.
groupMode one of none, selected, member-groups, all   Which groups are pushed: none, selected, member-groups or all.
groups list, or string    
groups[] string    
id string yes The client: its identifier or its entry’s DN.
jurisdiction string   A service deployed as cells (#553): the jurisdiction the service provider is in, as the cell map spells one (us, eu, ca). Each person’s home cell asks the issuance policy (release-attributes, purpose scim-provision) before pushing them there; a refusal leaves them out of scope. Empty is unknown, which the strict default never releases to. Ignored in a service that is one cell.
maxRequestsPerSecond string   The most requests a second the service provider is sent; every request waits for its turn rather than failing. Empty or 0 is no limit. In a service deployed as cells each pushing cell may send this divided by the pushing cells, rounded up (#553).
name string   What to call it on a page.
oauthClientAuth one of client_secret_basic, client_secret_post   oauth2: how the client authenticates at the token endpoint.
oauthClientId string   oauth2: the client_id.
oauthClientSecret string   oauth2: the client secret, write-only.
oauthResource string   oauth2: an RFC 8707 resource, if any.
oauthScope string   oauth2: the scope asked for, if any.
password string   basic: the password, write-only. On a change, empty keeps the one set.
reconcileMinutes string   Minutes between scheduled reconciliations; 0 is on demand only.
scopeFilter string   filter: an RFC 4515 LDAP filter.
scopeGroups list, or string    
scopeGroups[] string    
scopeMode one of all, groups, filter   Who is pushed: all, groups, or filter.
tlsCertificate string   uploaded: the PEM certificate and its chain.
tlsPrivateKey string   uploaded: the PEM private key, write-only.
tlsSource one of none, issued, uploaded   The TLS client certificate: none, issued (issue-certificate) or uploaded.
tokenEndpoint string   oauth2: the token endpoint.
username string   basic: the user name.

200: The client as the register now answers it.

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

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

Member Type Required What it is
cell string    
cells list    
cells[].cell string    
cells[].count number    
cells[].message string    
cells[].ok boolean    
cells[].reachable boolean    
certificate object    
certificate.notAfter string, or null    
certificate.rootPem string, or null    
certificate.serial string, or null    
certificate.subject string, or null    
client object    
client.authMethod string    
client.baseUrl string    
client.byCell list    
client.byCell[].cell string    
client.byCell[].counts object    
client.byCell[].counts.dead number    
client.byCell[].counts.queued number    
client.byCell[].counts.retrying number    
client.byCell[].counts.sent number    
client.byCell[].dead list    
client.byCell[].dead[].attempts number, or null    
client.byCell[].dead[].client string    
client.byCell[].dead[].clientId string    
client.byCell[].dead[].finishedAt string    
client.byCell[].dead[].generation number, or null    
client.byCell[].dead[].holder string    
client.byCell[].dead[].id string    
client.byCell[].dead[].inFlight boolean    
client.byCell[].dead[].lastAttemptAt string    
client.byCell[].dead[].name string    
client.byCell[].dead[].nextAttemptAt string    
client.byCell[].dead[].pendingChange boolean    
client.byCell[].dead[].queuedAt string    
client.byCell[].dead[].realm string, or null    
client.byCell[].dead[].state string    
client.byCell[].dead[].status number, or string, or null    
client.byCell[].dead[].type string    
client.byCell[].dead[].uri string, or null    
client.byCell[].dead[].uuid string    
client.byCell[].dead[].why string, or null    
client.byCell[].error string    
client.byCell[].failures number    
client.byCell[].here boolean    
client.byCell[].identifier string    
client.byCell[].lastReconcileAt string    
client.byCell[].pausedUntil string    
client.byCell[].pushes boolean    
client.byCell[].queued list    
client.byCell[].queued[].attempts number, or null    
client.byCell[].queued[].client string    
client.byCell[].queued[].clientId string    
client.byCell[].queued[].finishedAt string    
client.byCell[].queued[].generation number, or null    
client.byCell[].queued[].holder string    
client.byCell[].queued[].id string    
client.byCell[].queued[].inFlight boolean    
client.byCell[].queued[].lastAttemptAt string    
client.byCell[].queued[].name string    
client.byCell[].queued[].nextAttemptAt string    
client.byCell[].queued[].pendingChange boolean    
client.byCell[].queued[].queuedAt string    
client.byCell[].queued[].realm string, or null    
client.byCell[].queued[].state string    
client.byCell[].queued[].status number, or string, or null    
client.byCell[].queued[].type string    
client.byCell[].queued[].uri string, or null    
client.byCell[].queued[].uuid string    
client.byCell[].queued[].why string, or null    
client.byCell[].reachable boolean    
client.byCell[].retrying list    
client.byCell[].retrying[].attempts number, or null    
client.byCell[].retrying[].client string    
client.byCell[].retrying[].clientId string    
client.byCell[].retrying[].finishedAt string    
client.byCell[].retrying[].generation number, or null    
client.byCell[].retrying[].holder string    
client.byCell[].retrying[].id string    
client.byCell[].retrying[].inFlight boolean    
client.byCell[].retrying[].lastAttemptAt string    
client.byCell[].retrying[].name string    
client.byCell[].retrying[].nextAttemptAt string    
client.byCell[].retrying[].pendingChange boolean    
client.byCell[].retrying[].queuedAt string    
client.byCell[].retrying[].realm string, or null    
client.byCell[].retrying[].state string    
client.byCell[].retrying[].status number, or string, or null    
client.byCell[].retrying[].type string    
client.byCell[].retrying[].uri string, or null    
client.byCell[].retrying[].uuid string    
client.byCell[].retrying[].why string, or null    
client.byCell[].withheld string    
client.caCertificates string    
client.cells list    
client.cells[] string    
client.certificate object    
client.certificate.error string    
client.certificate.issuer string    
client.certificate.notAfter string, or null    
client.certificate.serial string, or null    
client.certificate.subject string    
client.counts object    
client.counts.dead number    
client.counts.queued number    
client.counts.retrying number    
client.counts.sent number    
client.deprovision string    
client.dn string    
client.enabled boolean    
client.failures number    
client.groupMode string    
client.groups list    
client.groups[] string    
client.id string    
client.identifier string    
client.jurisdiction string    
client.lastReconcile object    
client.lastReconcile.deprovisioned number    
client.lastReconcile.groups number    
client.lastReconcile.notPushedHere boolean    
client.lastReconcile.ok boolean    
client.lastReconcile.users number    
client.lastReconcile.why string    
client.lastReconcileAt string    
client.maxRequestsPerSecond string    
client.name string    
client.oauthClientAuth string    
client.oauthClientId string    
client.oauthClientSecretSet boolean    
client.oauthResource string    
client.oauthScope string    
client.passwordSet boolean    
client.pausedUntil string    
client.problems list    
client.problems[] string    
client.reconcileMinutes string    
client.scopeFilter string    
client.scopeGroups list    
client.scopeGroups[] string    
client.scopeMode string    
client.tlsCertificate string    
client.tlsPrivateKeySet boolean    
client.tlsSource string    
client.tokenEndpoint string    
client.usable boolean    
client.username string    
count number    
deprovisioned number    
discovery object    
discovery.endpoints map   The path of each resource type, by its name.
discovery.endpoints.{key} string    
discovery.etag boolean    
discovery.filter boolean    
discovery.ok boolean    
discovery.patch boolean    
discovery.why string    
errors list    
errors[] string    
groups number    
message string    
notPushedHere boolean    
ok boolean yes  
reachable boolean    
totalResults number, or null    
users number    
why string    

GET /admin-api/scim/monitor

getScimMonitor

How many SCIM calls there have been, from whom, of what kind, and how many failed

Everything /admin/scim/monitor draws: the call totals, one row per operation with its successes, failures, latency and bytes returned, one row per resource type, one row per authenticated client, the authentication schemes with the ones at zero included, what went back by status class, status and scimType, and the last fifty requests individually.

A CLIENT IS AN AUTHENTICATED PRINCIPAL, NOT A CONNECTION. SCIM is stateless HTTP — no session, no registration, nothing to be connected — so authentication.distinct is how many different names have successfully authenticated since this process started. It never goes down: a provisioning client that has stopped calling is indistinguishable from one that is between calls.

A REFUSED CALLER IS NOT A CLIENT. Calls the gate turned away are counted in authentication.refused and appear in no clients row, even when the credential carried a name — Basic and Digest both put one on the wire. Attributing traffic to an identity this service declined to believe is the one mistake this reply could make that would matter.

THE OPERATION COUNTS DO NOT SUM TO calls. One POST /scim/v2/Bulk carrying five creates is one bulk AND five creates, because each of the five really is performed.

AN ABSENT MEASUREMENT IS NULL AND NOT ZERO. averageMs, maxMs and successRate are null where nothing has been called: an average over no samples is absent, and a 100% success rate on zero requests is the most misleading number here.

The counters are IN MEMORY, start with the process (since) and are PER TRUST REALM, like the directory SCIM writes into. The durable record of what SCIM was asked to do is GET /admin-api/audit, which has the actor and the target as well as the count.

Mirrors GET /admin/scim/monitor on the admin console.

Scope: admin:read.

Parameters

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

200: The call totals, the per-operation, per-resource, per-client and per-scheme breakdowns, and the recent requests.

Member Type Required What it is
authRequired boolean    
baseUrl string, or null    
counters object    
counters.authentication object    
counters.authentication.anonymous number    
counters.authentication.applications number    
counters.authentication.byScheme map   A count per name.
counters.authentication.byScheme.{key} number    
counters.authentication.cap number    
counters.authentication.capped boolean    
counters.authentication.distinct number    
counters.authentication.identities number    
counters.authentication.refused number    
counters.byScimType map   A count per name.
counters.byScimType.{key} number    
counters.byStatus map   A count per name.
counters.byStatus.{key} number    
counters.byStatusClass map   A count per name.
counters.byStatusClass.{key} number    
counters.bytesOut number    
counters.calls number    
counters.clients list    
counters.clients[].calls number    
counters.clients[].failed number    
counters.clients[].firstAt number, or string, or null    
counters.clients[].kind string, or null    
counters.clients[].lastAt number, or string, or null    
counters.clients[].lastOperation string, or null    
counters.clients[].lastStatus number, or string, or null    
counters.clients[].ok number    
counters.clients[].principal string, or null    
counters.clients[].resourceTypes list    
counters.clients[].resourceTypes[] string    
counters.clients[].schemes list    
counters.clients[].schemes[] string    
counters.failed number    
counters.firstAt number, or string, or null    
counters.lastAt number, or string, or null    
counters.latency object    
counters.latency.averageMs number, or null    
counters.latency.maxMs number    
counters.latency.totalMs number    
counters.ok number    
counters.operations list    
counters.operations[].averageMs number, or null    
counters.operations[].bytes number    
counters.operations[].count number    
counters.operations[].failed number    
counters.operations[].label string    
counters.operations[].maxMs number, or null    
counters.operations[].method string    
counters.operations[].ok number    
counters.operations[].operation string    
counters.operations[].what string    
counters.realm object    
counters.realm.id string, or null    
counters.realm.name string, or null    
counters.recent list    
counters.recent[].at number, or string, or null    
counters.recent[].bytes number, or null    
counters.recent[].method string, or null    
counters.recent[].ms number, or null    
counters.recent[].ok boolean    
counters.recent[].operation string, or null    
counters.recent[].path string, or null    
counters.recent[].principal string, or null    
counters.recent[].resourceType string, or null    
counters.recent[].scheme string, or null    
counters.recent[].scimType string, or null    
counters.recent[].status number, or string, or null    
counters.recentCap number    
counters.resourceTypes list    
counters.resourceTypes[].count number    
counters.resourceTypes[].resourceType string, or null    
counters.since number, or string, or null    
counters.successRate number, or null    
enabled boolean    
installed boolean    
schemes list    
schemes[].applicationScoped boolean    
schemes[].canonical boolean    
schemes[].challenged boolean    
schemes[].description string    
schemes[].enabled boolean    
schemes[].id string    
schemes[].name string    
schemes[].primary boolean    
schemes[].recorded boolean    
schemes[].refusedByMode string    
schemes[].scoped boolean    
schemes[].setting string    
schemes[].spec string    
schemes[].specUri string    
schemes[].type string    
store object    
store.baseDn string    
store.entryCount number    
store.groupCount number    
store.groups string    
store.maxEntries number    
store.userCount number    
store.users string    
store.what string