Managing User Container Registry Credentials

You can update and retrieve the user container registry credentials through the registry API. This ensures that the Siebel CRM base image can be pulled from the user registry for Siebel CRM environment creations in the future.

This topic contains the following sections:

Updating User Container Registry Credentials
Retrieving User Container Registry Credentials

Updating User Container Registry Credentials

To update the user container registry credentials, call the registry API as follows:

PUT endpoint:

https://<CM_Instance_IP>:<port_num>/scm/api/v1.0/registry

Sample payload:

{
      "registry_url": "iad.ocir.io",
      "registry_user": "deploygroup/user.name@example.com",
      "registry_password": "aDgFFg123",
      "registry_prefix": "deploygroup"
}

Specify payload parameters suitable for your circumstances by referring to the following payload parameters:

Payload Parameter	Section	Definition
registry_user	Top Level	(Required) Specifies the user ID to connect to the container registry. This user must have access to push and pull images from container registry.
registry_url	Top Level	(Required) Specifies the URL of the Open Container Initiative compliant container registry. For example, for the OCI container registry in the Ashburn region, you might use `iad.ocir.io`. For more information, see the Preparing for Container Registry topic in the Oracle Cloud Infrastructure documentation.
registry_password	Top Level	(Required) Specifies the password or authentication token for `registry_user`.
registry_prefix	Top Level	(Optional) Specifies a prefix that's appended after registry_url. For OCI container registry, this should be the tenancy namespace, if needed, you can add a suffix to it. As it's an optional field, it can be left blank.

Retrieving User Container Registry Credentials

To retrieve the user container registry credentials, call the registry API as follows:

GET endpoint:

https://<CM_Instance_IP>:<port_num>/scm/api/v1.0/registry

Sample response:

{
      "data": {
            "registry_password": "********",
            "registry_prefix": "deploygroup",
            "registry_url": "iad.ocir.io",
            "registry_user": "deploygroup/user.name@example.com"
      },
      "message": "Registry details have been fetched successfully.",
      "status": "success"
}

Note: To ensure security, sensitive data such as the registry password is masked in the response.