--- title: Cerner connector description: Connectors continue to be released outside the IDM release. For the latest documentation, refer to the OpenICF documentation. component: pingidm version: 7.2 page_id: pingidm:connector-reference:cerner canonical_url: https://docs.pingidentity.com/pingidm/7.2/connector-reference/cerner.html section_ids: before_you_start: Before you start install_the_cerner_connector: Install the Cerner connector configure_the_cerner_connector: Configure the Cerner connector use_the_cerner_connector: Use the Cerner connector implemented-interfaces-org-forgerock-openicf-connectors-cerner-CernerConnector-1.5.20.15: OpenICF Interfaces Implemented by the Cerner Connector config-properties-org-forgerock-openicf-connectors-cerner-CernerConnector-1.5.20.15: Cerner Connector Configuration configuration-properties-org-forgerock-openicf-connectors-cerner-CernerConnector-1.5.20.15: Configuration properties --- # Cerner connector | | | | - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Connectors continue to be released outside the IDM release. For the latest documentation, refer to the [OpenICF documentation](https://docs.pingidentity.com/openicf/index.html). | Cerner is a healthcare-related service which provides an integrated healthcare IT solution for large healthcare providers. The Cerner connector lets you manage and synchronize accounts between Cerner and IDM managed user objects. A Cerner system account is required for this connector to work. ## Before you start Before you configure the connector, log in to your Cerner system account and note the following: * Bearer token The bearer token associated with your system account. * Tenant Your Cerner tenant ID. * Region The Cerner Cloud region where the tenant resides. ## Install the Cerner connector Download the connector .jar file from the [Backstage download site](https://backstage.forgerock.com/downloads). * If you are running the connector locally, place it in the `/path/to/openidm/connectors` directory, for example: ``` mv ~/Downloads/cerner-connector-1.5.20.15.jar /path/to/openidm/connectors/ ``` * If you are using a remote connector server (RCS), place it in the `/path/to/openicf/connectors` directory on the RCS. ## Configure the Cerner connector Create a connector configuration using the admin UI: 1. Select Configure > Connectors and click New Connector. 2. Enter a Connector Name. 3. Select Cerner Connector - 1.5.20.15 as the Connector Type. 4. Provide the Base Connector Details. 5. Click Save. When your connector is configured correctly, the connector displays as Active in the admin UI. Alternatively, test that the configuration is correct by running the following command: ``` curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Accept-API-Version: resource=1.0" \ --request POST \ "http://localhost:8080/openidm/system/Cerner?_action=test" { "name": "Cerner", "enabled": true, "config": "config/provisioner.openicf/Cerner", "connectorRef": { "bundleVersion": "[1.5.0.0,1.6.0.0)", "bundleName": "org.forgerock.openicf.connectors.cerner-connector", "connectorName": "org.forgerock.openicf.connectors.cerner.CernerConnector" }, "displayName": "Cerner Connector", "objectTypes": [ "__ORGANIZATION__", "__ACCOUNT__", "__ORGANIZATIONGROUP__", "__ALL__", "__PERSONNELGROUP__" ], "ok": true } ``` If the command returns `"ok": true`, your connector was configured correctly and can authenticate to the Cerner system. ## Use the Cerner connector **Supported object types** | Connector resource | Cerner resource type | | ----------------------- | -------------------- | | `__ACCOUNT__` | Personnel | | `__ORGANIZATION__` | Organization | | `__PERSONNELGROUP__` | Personnel Group | | `__ORGANIZATIONGROUP__` | Organization Group | > **Collapse: attributes** > > | Attribute | Notes | > | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | `__NAME__` | The user's name, in a `FAMILY, GIVEN` format. Required. | > | `birthDate` | Must be in `YYYY-MM-DD` format. | > | `gender` | Accepted values are `MALE`, `FEMALE`, `OTHER`, `UNKNOWN`. | > | `given` | The user's first name. Required. | > | `family` | The user's last name. Required. | > | `name` | given middle family suffix prefix | > | `addresses` | postalCode country use Accepted values are HOME or WORK. city state lines The street portion of the address. | > | `aliasType` | Accepted values are: `SPI`, `TAX`, `SL`, `EXTERNAL`, `UPIN`, `USER`, or `UNKNOWN`. Required. | > | `aliasValue` | | > | `aliasSystem` | | > | `sourceIdentifiers` | id dataPartitionId | > | `qualifications` | issuer code Qualification code such as MD or PhD. Accepted values are: AA, AAS, ABA, AE, AS, BA, BBA, BE, BFA, BN, BS, BSL, BSN, BT, CANP, CER, CMA, CNM, CNP, CNS, CPNP, CRN, CTR, DBA, DED, DIP, DO, EMT, EMTP, FPNP, HS, JD, MA, MBA, MCE, MD, MDA, MDI, ME, MED, MEE, MFA, MME, MS, MSL, MSN, MT, MTH, NG, NP, PA, PHD, PHE, PNS, PN, PharmD, RMA, RN, RPH, SEC, or TS. start The first date and time that the qualification is valid, in a YYYY-MM-DDThh:mm:ssZ date format. end The date and time that the qualification expires, in a YYYY-MM-DDThh:mm:ssZ date format. | > | `telecoms` | system Accepted values are PHONE, EMAIL, or OTHER. value | > | `languages` | For a list of valid language tags, refer to the *Internet Assigned Numbers Authority* (IANA) [language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). | > **Collapse: attributes** > > | Attribute | Notes | > | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | `__NAME__` | The name of the organization. This corresponds to `aliasValue`, `aliasSystem`, comma separated. Required. | > | `name` | The name of the organization. Required. | > | `aliasType` | Alias types related to the organization. `DEA`, `TAX`, `SOI`, and `NPI` are supported for queries. Organizations with `NPI` and `DEA` cannot be created or updated. | > | `telecoms` | system Accepted values are PHONE, EMAIL, or OTHER. value | > | `addresses` | postalCode country text Formatted display text of the address. city state lines The street portion of the address. | > | `aliases` | type Types of alias for the organization. system value | > | `languages` | For a list of valid language tags, refer to the *Internet Assigned Numbers Authority* (IANA) [language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). | > | `coverageAreaPostalCodes` | The postal codes indicating the area of coverage provided by the organization. | > | `sourceIdentifiers` | id dataPartitionId | > **Collapse: attributes** > > | Attribute | Notes | > | -------------- | -------------------------------------------------------------------------------------- | > | `__NAME__` | A comma-separated name for the personnel group. | > | `mnemonic` | The mnemonic determines the function of the personnel group. | > | `mnemonicType` | The type of the personnel group mnemonic. Usually either `SINGLETON` or `MULTIVALUED`. | > | `name` | The name of the personnel group. | > | `aliases` | type system value | > | `aliasType` | The type of alias. Requires `aliasValue` and `aliasSystem`. | > | `aliasSystem` | The source of the alias value. Requires `aliasType` and `aliasValue`. | > | `aliasValue` | The unique identifier of alias. Requires `aliasType` and `aliasSystem`. | > **Collapse: attributes** > > | Attribute | Notes | > | ---------------- | -------------------------------------------------------------------------------------- | > | `__NAME__` | A comma-separated name for the organization group. | > | `organizationId` | A list of organization IDs that are members of the organization group. | > | `name` | The name of the organization group. | > | `aliases` | type system value | > | `aliasType` | The type of alias. Requires `aliasValue` and `aliasSystem`. | > | `aliasSystem` | The source of the alias value. Requires `aliasType` and `aliasValue`. | > | `aliasValue` | The unique identifier of alias. Requires `aliasType` and `aliasSystem`. | You can use the Cerner connector to perform the following actions on a Cerner account: > **Collapse: Create a Cerner user** > > The following example creates a user with the minimum required attributes: > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --request POST \ > --data '{ > "given": "Barbara", > "family": "Jensen", > "aliasType": "USER", > "__NAME__": "Jensen, Barbara" > }' \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__?_action=create" > { > "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "updatedAt": "2022-04-29T22:54:08Z", > "given": "Barbara", > "name": { > "given": "Barbara", > "family": "Jensen", > "formatted": "Barbara Jensen" > }, > "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "languages": [], > "formattedName": "Barbara Jensen", > "aliases": { > "type": "USER", > "value": "Jensen", > "system": "Barbara" > }, > "aliasValue": "Jensen", > "__NAME__": "Jensen,Barbara", > "createdAt": "2022-04-29T22:54:08Z", > "aliasType": "USER", > "family": "Jensen", > "isManual": true, > "aliasSystem": "Barbara" > } > ``` > > | | | > | - | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | | When you create a new user, you must specify *at least* `__NAME__`, `aliasType`, `given`, and `family`. Refer to the list of [account attributes](#account-attributes) for more information. | > **Collapse: Update a Cerner user** > > You can modify an existing user with a PUT request, including all attributes of the account in the request: > > For example, to add the user's middle name: > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --header "If-Match:*" \ > --request PUT \ > --data '{ > "given": "Barbara", > "family": "Jensen", > "aliasType": "USER", > "__NAME__": "Jensen, Barbara", > "name": { > "middle": "Simone" > } > }' \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" > { > "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "updatedAt": "2022-04-29T23:03:57Z", > "given": "Barbara", > "name": { > "given": "Barbara", > "middle": "Simone", > "family": "Jensen", > "formatted": "Barbara Simone Jensen" > }, > "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "languages": [], > "formattedName": "Barbara Simone Jensen", > "aliases": { > "type": "USER", > "value": "Jensen", > "system": "Barbara" > }, > "aliasValue": "Jensen", > "__NAME__": "Jensen,Barbara", > "createdAt": "2022-04-29T22:54:08Z", > "aliasType": "USER", > "family": "Jensen", > "isManual": true, > "aliasSystem": "Barbara" > } > ``` > **Collapse: Query Cerner users** > > The following example queries all Cerner users: > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --request GET \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__?_queryId=query-all-ids" > { > "result": [ > { > "_id": "7d9538c8-1c2a-4894-a403-129b35308f39" > }, > { > "_id": "8f1c2671-9ebb-4105-9537-a3a0fc24afce" > }, > { > "_id": "ac944860-705f-4487-99bf-6959c5e6157c" > }, > { > "_id": "d308e459-51fa-469a-a07e-72f96906a4b4" > }, > { > "_id": "ff9d6902-20be-4c6e-821a-5a0f3ccaebc8" > }, > { > "_id": "bf2b9346-715e-4f59-9dc5-2bc89b8216cd" > }, > { > "_id": "055def33-a845-4100-bcd1-2b59a3526ec5" > }, > { > "_id": "167609b8-dfd0-4302-9022-4a3e8809b166" > }, > [ ... ] > { > "_id": "9f4ea23d-bacc-46ee-b8c9-75916a5f5128" > }, > { > "_id": "a4d6be21-a5ce-4a56-91af-94c627701d4f" > } > ], > "resultCount": 1020, > "pagedResultsCookie": null, > "totalPagedResultsPolicy": "NONE", > "totalPagedResults": -1, > "remainingPagedResults": -1 > } > ``` > > | | | > | - | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | > | | Querying all ids can take a significant amount of time to return when the data set is large. Consider using paginated results instead, for example:``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --request GET \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__?_queryFilter=true&_fields=_id&_pageSize=2&_pagedResultsOffset=50" > { > "result": [ > { > "_id": "878c87d4-8322-4908-a858-555a1cb45e36" > }, > { > "_id": "9ecaa98b-58df-4dd1-bc99-34341411b151" > } > ], > "resultCount": 2, > "pagedResultsCookie": null, > "totalPagedResultsPolicy": "NONE", > "totalPagedResults": -1, > "remainingPagedResults": -1 > } > ``` | > > The following command queries a specific user by their ID: > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --request GET \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" > { > "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "updatedAt": "2022-04-29T23:03:57Z", > "given": "Barbara", > "name": { > "given": "Barbara", > "middle": "Simone", > "family": "Jensen", > "formatted": "Barbara Simone Jensen" > }, > "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "languages": [], > "formattedName": "Barbara Simone Jensen", > "aliases": { > "type": "USER", > "value": "Jensen", > "system": "Barbara" > }, > "aliasValue": "Jensen", > "__NAME__": "Jensen,Barbara", > "createdAt": "2022-04-29T22:54:08Z", > "aliasType": "USER", > "family": "Jensen", > "isManual": true, > "aliasSystem": "Barbara" > } > ``` > **Collapse: Delete a Cerner user account** > > You can use the Cerner connector to delete an account from the Cerner repository. > > The following example deletes a Cerner account: > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --request DELETE \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" > { > "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "updatedAt": "2022-04-29T23:03:57Z", > "given": "Barbara", > "name": { > "given": "Barbara", > "middle": "Simone", > "family": "Jensen", > "formatted": "Barbara Simone Jensen" > }, > "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "languages": [], > "formattedName": "Barbara Simone Jensen", > "aliases": { > "type": "USER", > "value": "Jensen", > "system": "Barbara" > }, > "aliasValue": "Jensen", > "__NAME__": "Jensen,Barbara", > "createdAt": "2022-04-29T22:54:08Z", > "aliasType": "USER", > "family": "Jensen", > "isManual": true, > "aliasSystem": "Barbara" > } > ``` All supported resources can be queried. You can update user accounts, organizations, organization groups, and personnel groups, but only user accounts can be created or deleted. Available additional operations include: > **Collapse: Assign personnel groups to a user** > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --header "If-Match:*" \ > --request PUT \ > --data '{ > "given": "Barbara", > "family": "Jensen", > "aliasType": "USER", > "__NAME__": "Jensen, Barbara", > "name": { > "middle": "Simone" > }, > "personnelGroupId": [ > "8636d4c3-de7c-4f8a-828b-b709d6bfd636" > ] > }' \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" > { > "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "formattedName": "Barbara Simone Jensen", > "__NAME__": "Jensen,Barbara", > "aliasValue": "Jensen", > "family": "Jensen", > "updatedAt": "2022-10-25T23:50:31Z", > "aliasType": "USER", > "given": "Barbara", > "organizationId": [], > "aliasSystem": "Barbara", > "name": { > "given": "Barbara", > "middle": "Simone", > "family": "Jensen", > "formatted": "Barbara Simone Jensen" > }, > "languages": [], > "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "isManual": true, > "personnelGroupId": [ > "8636d4c3-de7c-4f8a-828b-b709d6bfd636" > ], > "aliases": { > "type": "USER", > "value": "Jensen", > "system": "Barbara" > }, > "createdAt": "2022-04-29T22:54:08Z" > } > ``` > **Collapse: Remove a user from a personnel group** > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --header "If-Match:*" \ > --request PUT \ > --data '{ > "given": "Barbara", > "family": "Jensen", > "aliasType": "USER", > "__NAME__": "Jensen, Barbara", > "name": { > "middle": "Simone" > }, > "personnelGroupId": [] > }' \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" > { > "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "formattedName": "Barbara Simone Jensen", > "__NAME__": "Jensen,Barbara", > "aliasValue": "Jensen", > "family": "Jensen", > "updatedAt": "2022-10-26T00:03:40Z", > "aliasType": "USER", > "given": "Barbara", > "organizationId": [], > "aliasSystem": "Barbara", > "name": { > "given": "Barbara", > "middle": "Simone", > "family": "Jensen", > "formatted": "Barbara Simone Jensen" > }, > "languages": [], > "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "isManual": true, > "personnelGroupId": [], > "aliases": { > "type": "USER", > "value": "Jensen", > "system": "Barbara" > }, > "createdAt": "2022-04-29T22:54:08Z" > } > ``` > **Collapse: Assign an organization member** > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --header "If-Match:*" \ > --request PUT \ > --data '{ > "given": "Barbara", > "family": "Jensen", > "aliasType": "USER", > "__NAME__": "Jensen, Barbara", > "name": { > "middle": "Simone" > }, > "organizationId": [ > "c66f037b-50f5-4703-b51f-838f42a49e84" > ] > }' \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" > { > "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "formattedName": "Barbara Simone Jensen", > "__NAME__": "Jensen,Barbara", > "aliasValue": "Jensen", > "family": "Jensen", > "updatedAt": "2022-10-26T00:03:40Z", > "aliasType": "USER", > "given": "Barbara", > "organizationId": [ > "c66f037b-50f5-4703-b51f-838f42a49e84" > ], > "aliasSystem": "Barbara", > "name": { > "given": "Barbara", > "middle": "Simone", > "family": "Jensen", > "formatted": "Barbara Simone Jensen" > }, > "languages": [], > "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "isManual": true, > "personnelGroupId": [], > "aliases": { > "type": "USER", > "value": "Jensen", > "system": "Barbara" > }, > "createdAt": "2022-04-29T22:54:08Z" > } > ``` > **Collapse: Remove an organization member** > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --header "If-Match:*" \ > --request PUT \ > --data '{ > "given": "Barbara", > "family": "Jensen", > "aliasType": "USER", > "__NAME__": "Jensen, Barbara", > "name": { > "middle": "Simone" > }, > "organizationId": [] > }' \ > "http://localhost:8080/openidm/system/Cerner/__ACCOUNT__/5170a9cd-e501-4cbf-a1bf-9e6d293362c6" > { > "_id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "formattedName": "Barbara Simone Jensen", > "__NAME__": "Jensen,Barbara", > "aliasValue": "Jensen", > "family": "Jensen", > "updatedAt": "2022-10-26T00:03:40Z", > "aliasType": "USER", > "given": "Barbara", > "organizationId": [], > "aliasSystem": "Barbara", > "name": { > "given": "Barbara", > "middle": "Simone", > "family": "Jensen", > "formatted": "Barbara Simone Jensen" > }, > "languages": [], > "id": "5170a9cd-e501-4cbf-a1bf-9e6d293362c6", > "isManual": true, > "personnelGroupId": [], > "aliases": { > "type": "USER", > "value": "Jensen", > "system": "Barbara" > }, > "createdAt": "2022-04-29T22:54:08Z" > } > ``` > **Collapse: Assign an organization to an organization group** > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --header "If-Match:*" \ > --request PUT \ > --data '{ > "organizationId": [ > "f90a6224-1880-4935-a838-e19d3079a23c", > "19b5157e-6fbe-4716-860b-28d6df90f331", > "c66f037b-50f5-4703-b51f-838f42a49e84" > ] > }' \ > "http://localhost:8080/openidm/system/Cerner/__ORGANIZATIONGROUP__/67203020-aae7-4f44-865f-c8591d618ffc" > { > "_id": "67203020-aae7-4f44-865f-c8591d618ffc", > "organizationId": [ > "c66f037b-50f5-4703-b51f-838f42a49e84", > "f90a6224-1880-4935-a838-e19d3079a23c", > "19b5157e-6fbe-4716-860b-28d6df90f331" > ], > "updatedAt": "2022-05-06T12:56:02Z", > "aliases": { > "type": "SOGI", > "value": "0001ORGVALUE", > "system": "0001System" > }, > "id": "67203020-aae7-4f44-865f-c8591d618ffc", > "aliasType": "SOGI", > "aliasValue": "0001ORGVALUE", > "aliasSystem": "0001System", > "name": "ABC SK ORG GROUP", > "createdAt": "2022-05-06T12:56:02Z", > "__NAME__": "0001ORGVALUE,0001System" > } > ``` > **Collapse: Remove an organization from an organization group** > > ``` > curl \ > --header "X-OpenIDM-Username: openidm-admin" \ > --header "X-OpenIDM-Password: openidm-admin" \ > --header "Content-Type: application/json" \ > --header "If-Match:*" \ > --request PUT \ > --data '{ > "organizationId": [ > "f90a6224-1880-4935-a838-e19d3079a23c", > "19b5157e-6fbe-4716-860b-28d6df90f331" > ] > }' \ > "http://localhost:8080/openidm/system/Cerner/__ORGANIZATIONGROUP__/67203020-aae7-4f44-865f-c8591d618ffc" > { > "_id": "67203020-aae7-4f44-865f-c8591d618ffc", > "organizationId": [ > "f90a6224-1880-4935-a838-e19d3079a23c", > "19b5157e-6fbe-4716-860b-28d6df90f331" > ], > "updatedAt": "2022-05-06T12:56:02Z", > "aliases": { > "type": "SOGI", > "value": "0001ORGVALUE", > "system": "0001System" > }, > "id": "67203020-aae7-4f44-865f-c8591d618ffc", > "aliasType": "SOGI", > "aliasValue": "0001ORGVALUE", > "aliasSystem": "0001System", > "name": "ABC SK ORG GROUP", > "createdAt": "2022-05-06T12:56:02Z", > "__NAME__": "0001ORGVALUE,0001System" > } > ``` ## OpenICF Interfaces Implemented by the Cerner Connector The Cerner Connector implements the following OpenICF interfaces. For additional details, see [OpenICF interfaces](interfaces.html): * Create Creates an object and its `uid`. * Delete Deletes an object, referenced by its `uid`. * Schema Describes the object types, operations, and options that the connector supports. * Script on Connector Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: * The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. * The script has access to a `connector` variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. * The script has access to any script arguments passed in by the application. * Search Searches the target resource for all objects that match the specified object class and filter. * Test Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. * Update Updates (modifies or replaces) objects on a target resource. ## Cerner Connector Configuration The Cerner Connector has the following configurable properties: ### Configuration properties | Property | Type | Default | Encrypted(1) | Required(2) | | ------------------------------------------------- | --------------- | ------------ | ------------------------ | ------------------------- | | `bearerToken` | `GuardedString` | `null` | [icon: lock, set=fas]Yes | [icon: check, set=fas]Yes | | Provide the bearer token to authorize Cerner | | | | | | `tenant` | `String` | `playground` | | [icon: times, set=fas]No | | Provide the tenant to authorize Cerner | | | | | | `region` | `String` | `us-1` | | [icon: times, set=fas]No | | Provide the region to authorize Cerner | | | | | | `maximumConnections` | `Integer` | `10` | | [icon: times, set=fas]No | | Provide the maximum connections | | | | | | `connectionTimeout` | `Integer` | `300` | | [icon: times, set=fas]No | | Provide the maximum connection timeout in seconds | | | | | | `httpProxyHost` | `String` | `null` | | [icon: check, set=fas]Yes | | Provide the Proxy Host | | | | | | `httpProxyPort` | `Integer` | `null` | | [icon: check, set=fas]Yes | | Provide the Proxy Port | | | | | | `httpProxyUsername` | `String` | `null` | | [icon: check, set=fas]Yes | | Provide the Proxy Username | | | | | | `httpProxyPassword` | `GuardedString` | `null` | [icon: lock, set=fas]Yes | [icon: check, set=fas]Yes | | Provide the Proxy Password | | | | | (1) Whether the property value is considered confidential, and is therefore encrypted in IDM. (2) A list of operations in this column indicates that the property is required for those operations.