application id/name
application data
a promise that resolves to an application object
Create an empty application export template
an empty application export template
Delete application
application uuid
Optionaldeep: boolean
deep delete (remove dependencies)
a promise that resolves to an application object
Delete application by name
application name
Optionaldeep: boolean
deep delete (remove dependencies)
a promise that resolves to an application object
Delete the objects an application owns: the OAuth2 client, the SAML entity providers (and their membership in circles of trust), the mappings and the connector that its record names. The record itself is not deleted (delete it first, with deep off, and pass the record that comes back), and the objects an application only shares (scripts, circles of trust, glossary schemas, request forms, request types) are never touched. An object that another application still names is kept. Every object is reported to the result callback once; a failure of one object does not stop the others and is not thrown.
the application record
Optionaloptions: ApplicationOwnedDeleteOptions
the ownership index to use (read once if not given) and the result callback
a promise that resolves to what happened to each owned object
Delete the objects an application owns, by application id. The application is read first, so it must still exist: to delete the record first, pass the record that deleteApplication returns to deleteApplicationOwnedObjects.
application uuid
Optionaloptions: ApplicationOwnedDeleteOptions
the ownership index to use (read once if not given) and the result callback
a promise that resolves to what happened to each owned object
Delete the objects an application owns, by application name. The application is read first, so it must still exist: to delete the record first, pass the record that deleteApplicationByName returns to deleteApplicationOwnedObjects.
application name
Optionaloptions: ApplicationOwnedDeleteOptions
the ownership index to use (read once if not given) and the result callback
a promise that resolves to what happened to each owned object
Delete all applications
Optionaldeep: boolean
deep delete (remove dependencies)
a promise that resolves to an array of application objects
Disable an application: disable its connector. An application without a connector has no status to change and is an error.
application uuid
a promise that resolves to the status of the application after the change
Disable an application by name. See disableApplication.
application name
a promise that resolves to the status of the application after the change
Enable an application: enable its connector and wait until the connector answers its connection test (see ConnectorOps.enableConnector). An application without a connector has no status to change and is an error.
application uuid
Optionaloptions: ConnectorEnableOptions
how long to wait for the connector to answer (milliseconds)
a promise that resolves to the status of the application after the change
Enable an application by name. See enableApplication.
application name
Optionaloptions: ConnectorEnableOptions
how long to wait for the connector to answer (milliseconds)
a promise that resolves to the status of the application after the change
Export application. The response can be saved to file as is.
application uuid
export options
Promise resolving to an ApplicationExportInterface object.
Export application by name. The response can be saved to file as is.
application name
export options
Promise resolving to an ApplicationExportInterface object.
Export all applications. The response can be saved to file as is.
Optionaloptions: ApplicationExportOptions
export options
OptionalresultCallback: ResultCallback<ApplicationGlossarySkeleton>
Optional callback to process individual results. When given, the outcome of every application is passed to it as it happens (a failed application as an error that names it, with the reasons nested) and a failed application does not throw: the applications that could be exported are returned. The dependencies of a failed application that were read before it failed may still be in the export. Without it, the failures are collected and thrown as one error after every application was tried. Failing to read the applications always throws.
Promise resolving to an ApplicationExportInterface object.
Find the applications that own an object in an ownership index.
the ownership index
what kind of object it is
the OAuth2 client id, the SAML entity id (decoded), the connector name or the mapping name
the applications that name the object, empty if none does
Build the ownership index from application records that you already have (read from a tenant or from files). Nothing is read. See readApplicationOwnership.
application records
which application owns which OAuth2 client, SAML provider, connector and mapping
List the references that an application record holds itself: the OAuth2 client, the SAML entity providers, the connector and the mappings it names, all of them owned by the application. Nothing is read, so this works on a record that comes from a file as well as on one read from a tenant.
application record
the references in the record
Get application managed object type
application managed object type in this realm
Import application. The import data is usually read from an application export file. The import writes the configuration fields of the application with a PUT. A PUT that does not carry members, owners and roles leaves them as they are, so an import does not remove who has access.
application uuid
application import data.
import options (deps: also import the dependencies of the application)
Promise resolving to an application object.
Import application by name. The import data is usually read from an application export file. The import writes the configuration fields of the application with a PUT. A PUT that does not carry members, owners and roles leaves them as they are, so an import does not remove who has access.
application name
application import data.
import options (deps: also import the dependencies of the application)
Promise resolving to an application object.
Import applications. The import data is usually read from an application export file. The import writes the configuration fields of the application with a PUT. A PUT that does not carry members, owners and roles leaves them as they are, so an import does not remove who has access. Every application is tried: an application that cannot be imported does not stop the others.
application import data.
import options (deps: also import the dependencies of the application)
OptionalresultCallback: ResultCallback<ApplicationGlossarySkeleton>
Optional callback to process individual results. When given, the outcome of every application is passed to it as it happens (a failed application as an error that names it, with the reasons nested) and a failed application does not throw: the applications that could be imported are returned. An application whose dependencies or glossary could not be imported is a failed application, although the application itself may have been written. Without it, the failures are collected and thrown as one error after every application was tried.
Import first application. The import data is usually read from an application export file. Only the first application of the import data is imported. The import writes the configuration fields of the application with a PUT. A PUT that does not carry members, owners and roles leaves them as they are, so an import does not remove who has access.
application import data.
import options (deps: also import the dependencies of the application)
a promise resolving to an array that holds the imported application
Query applications
CREST search filter
Optionalfields: string[]
array of fields to return
Read application
application uuid
a promise that resolves to an application object
Read application by name
application name
a promise that resolves to an application object
Read which application owns which object in the current realm: every OAuth2 client, SAML provider, connector and mapping that an application record names. Reads the applications once and nothing else, because the owned objects are named in the records. An object that two applications name lists both of them as owners; what that means is up to the caller. Objects that applications only share (scripts, circles of trust and the like) are not indexed.
a promise that resolves to the ownership index
Read what an application is made of: every object that its record points to, and the scripts, circles of trust and (on Identity Governance tenants) glossary schemas, request forms and request types that those objects use. Every reference says what it points to, whether the application owns it (it exists because of the application) or shares it (other applications can use it too), and where the reference comes from. References that could not be followed (the object does not exist, or could not be read) are listed as problems; they do not make the call fail.
application uuid
a promise that resolves to the references of the application
Read what an application is made of, by application name. See readApplicationReferences.
application name
a promise that resolves to the references of the application
Read all applications. Results are sorted aphabetically.
a promise that resolves to an array of application objects
Read the status of an application. Only a provisioning application, one with a connector, has a status, and it is the state of its connector: active if the connector is enabled, inactive if it is disabled. Every other application, and one whose connector configuration does not exist, has status none.
application uuid
a promise that resolves to the status of the application
Read the status of an application by name. See readApplicationStatus.
application name
a promise that resolves to the status of the application
Read the status of every application of the realm: the applications are read once and the enabled state of all connectors in one more request. See readApplicationStatus.
a promise that resolves to the status of every application
Update application
application uuid
application data
a promise that resolves to an application object
Validate an application: check that every object its record refers to, and every script, circle of trust and (on Identity Governance tenants) glossary schema, request form and request type that those objects use, exists. Reads only; no template is needed. One finding is returned for every reference that does not resolve or could not be checked.
application uuid
validation findings, empty if every reference resolves
Validate an application by name. See validateApplication.
application name
validation findings, empty if every reference resolves
Validate all applications of the realm. See validateApplication. A reference that cannot be followed in one application does not stop the validation of the others.
validation findings of all applications, empty if every reference resolves
Create application