Create a CIMD profile. Fails if a profile with that id exists (ids are unique ignoring case). The server completes the profile with its defaults, so a body with a client id URL pattern in cimdConfig is enough; values may be plain or wrapped as inherited/value. Fails with the error code CIMD_PROFILES_NOT_AVAILABLE if the realm does not offer CIMD profiles.
CIMD profile id
CIMD profile object
a promise that resolves to the created CIMD profile object as the server answers it (wrapped shape)
Create an empty CIMD profile export template
an empty CIMD profile export template
Delete a CIMD profile. Fails if the profile does not exist, and with the error code CIMD_PROFILES_NOT_AVAILABLE if the realm does not offer CIMD profiles.
CIMD profile id
a promise that resolves to the deleted CIMD profile object (wrapped shape)
Delete all CIMD profiles of the realm. Every profile is tried: a profile that cannot be deleted does not stop the others. If the realm does not offer CIMD profiles there is nothing to delete: the result is empty, no request for profiles is made and the callback is not called.
OptionalresultCallback: ResultCallback<CIMDProfileSkeleton>
Optional callback to process individual results. When given, the outcome of every profile is passed to it as it happens (a failed profile as an error that names the profile) and a failed profile does not throw. Without it, the failures are collected and thrown as one error after every profile was tried. Failing to read the profiles always throws.
a promise that resolves to the CIMD profiles that were deleted
Export a CIMD profile. The response can be saved to file as is. Fails with the error code CIMD_PROFILES_NOT_AVAILABLE if the realm does not offer CIMD profiles.
CIMD profile id
a promise that resolves to the export data
Export all CIMD profiles of the realm. The response can be saved to file as is. The profiles are written as readCIMDProfiles returns them (plain shape, as stored, including _id, _rev and _type). If the realm does not offer CIMD profiles the export holds none, and no request for profiles is made.
OptionalresultCallback: ResultCallback<CIMDProfileSkeleton>
Optional callback to process individual results. When given, the outcome of every profile is passed to it as it happens (a failed profile as an error that names the profile) and a failed profile does not throw. Without it, the failures are collected and thrown as one error after every profile was tried. Failing to read the profiles always throws.
a promise that resolves to the export data
Import a CIMD profile from CIMD profile import data. Fails with the error code CIMD_PROFILES_NOT_AVAILABLE if the realm does not offer CIMD profiles.
CIMD profile id
CIMD profile import data.
a promise that resolves to the stored profile, whether it was created and whether it was restored to the exported state by the second write
Import CIMD profiles. The import data is usually read from a CIMD profile export file. Existing profiles are replaced by exactly what the file holds. A profile that the server completes with its defaults because it did not exist (an export of a profile that was stored with few attributes) is written a second time so that it equals the exported one. If the realm does not offer CIMD profiles nothing is imported, one warning is printed and the result is empty. The scripts and journeys that a profile names must exist before it is imported.
CIMD profile import data.
OptionalresultCallback: ResultCallback<CIMDProfileImportResult>
Optional callback to process individual results. When given, the outcome of every profile is passed to it as it happens (a failed profile as an error that names the profile) and a failed profile does not throw. Without it, the failures are collected and thrown as one error after every profile was tried.
a promise that resolves to the result of each profile that was imported: the stored profile, whether it was created and whether it was restored to the exported state by the second write
Find out whether the realm offers CIMD profiles. The answer comes from the agent type list of the deployment,
which is kept per realm; a deployment without the type is a normal answer (false), not an error.
OptionalrefreshCache: boolean
true to ask the server again before answering, false to use the list read earlier. Default: false.
a promise that resolves to true if the realm offers the agent type CIMDProfile and false otherwise
Read a CIMD profile in the plain shape, the same object that readCIMDProfiles returns for it. The id is matched ignoring case, as the server does. Fails with the error code CIMD_PROFILES_NOT_AVAILABLE if the realm does not offer CIMD profiles.
CIMD profile id
a promise that resolves to a CIMD profile object
Read all CIMD profiles of the realm, sorted by id, in the plain shape. If the realm does not offer CIMD profiles the result is empty and no request for profiles is made.
a promise that resolves to an array of CIMD profile objects
Read the CIMD profile schema. Fails with the error code CIMD_PROFILES_NOT_AVAILABLE if the realm does not offer CIMD profiles.
a promise that resolves to the JSON schema of a CIMD profile
Read the CIMD profile template. The template is plain and not valid as it stands: the list of client id URL patterns is empty and the server requires at least one when it creates a profile. Fails with the error code CIMD_PROFILES_NOT_AVAILABLE if the realm does not offer CIMD profiles.
a promise that resolves to a CIMD profile template object
Update or create a CIMD profile. The server stores exactly what is sent when the profile exists: a body with only cimdConfig leaves a profile with only those attributes, a body without cimdConfig leaves a profile without client id URL patterns. Read the profile first and send every group that should be kept. When the id does not exist the profile is created and completed with the server's defaults. The server does not check revisions, so a concurrent update is lost without notice. Fails with the error code CIMD_PROFILES_NOT_AVAILABLE if the realm does not offer CIMD profiles.
CIMD profile id
CIMD profile object
a promise that resolves to the stored CIMD profile object as the server answers it (wrapped shape)
Validate a CIMD profile offline: say what the server refuses with a specific reason (error) and what it accepts but should not accept unnoticed (warning). Nothing is read from or written to the tenant, the profile is not modified and the answer never blocks a write: the server stays authoritative. The profile may be in the plain shape (as readCIMDProfiles returns it) or the wrapped shape ({ inherited, value }, as readCIMDProfile returns it); both give the same findings, and an inherited value counts as absent. Each finding has a stable code, a severity, a message that names the attribute and the value, and a JSON pointer to the attribute. The checks: the client id URL patterns (required, https:// in lower case, host, white space, wildcard port; wildcards in the host, no path, query, fragment, user info, dot segments, local addresses, duplicates), the metadata deny list, the SSRF switch, status, subject type, token endpoint authentication method, grant types, token lifetimes, redirect URIs and the attribute names. The rules are what a probe of an Identity Cloud tenant (AM 9.0.0) showed; a later build may refuse more or less.
the profile to validate
OptionalotherProfiles: CIMDProfileSkeleton[]
the other profiles of the realm (as readCIMDProfiles returns them): when given, each pattern is also compared with theirs, and a pattern that is identical to, inside or around a pattern of another profile is reported (a client id that matches two profiles is refused with invalid_client at run time). A profile with the same _id as profileData is skipped.
Optionalschema: CIMDProfileSchema
the schema of the profile (as readCIMDProfileSchema returns it): when given, the allowed values and the attribute names come from it, otherwise from the values the library knows
the findings, empty for a profile without any
Manage CIMD profiles (agent type
CIMDProfile).A CIMD profile is an allow-list of
https://client id URL patterns: a client whose client id matches a pattern of a profile may act as an OAuth 2.0 client without being registered (Client ID Metadata Documents). A deployment advertises whether it offers the type in its agent type list. Where it does not (the root realm of an Identity Cloud tenant, a tenant or a self-hosted server from before the feature), reading all profiles gives an empty list and every function that names a profile, the template or the schema fails with the error codeCIMD_PROFILES_NOT_AVAILABLE; OAuth2CIMDProfile.isCIMDProfileAvailable answers the question without an error.Reads return the plain shape (values without the
{ inherited, value }wrapper) as the profile is stored: a profile that was stored with few attributes has few attributes. Writes accept plain and wrapped values.