Change the Node Manager Credentials
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/credentials/update
Note the following before updating the credentials:
- Updating of credentials is not supported for service instances that were created before release 17.4.1. To find out whether a service instance was created before release 17.4.1, send a
GET
REST API request to the service instance (described in View a Service Instance). In the data that the API request returns, search for the line,"provisionEngine":"Metadata_x_y"
(for example,"provisionEngine":"Metadata_1_0"
). If the line exists, the service instance was created using release 17.4.1 or higher. If the line does not exist, the instance was created using a release before 17.4.1. - The WebLogic Administration Server should be running when updating the credentials.
- If you restore a service instance configuration using a backup that was taken before updating the credentials, the restored service instance will keep the updated credentials.
Request
- application/json
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
object
-
components:
object components
Groups properties for the Oracle WebLogic Server component (
WLS
).
object
WLS
).-
WLS:
object WLS
Properties for the Oracle WebLogic Server (WLS) component. Provide the Node Manager credentials. A set of credentials is the user name and password.
object
-
nodeManagerPassword:
string
Password for the Node Manager. The password must meet the following requirements:
- Starts with a letter
- Is between 8 and 30 characters long
- Has at least one number
- (Optional) Can have one or more of the following special characters: underscore (_), pound sign (#), dollar sign ($).
-
nodeManagerUserName:
string
User name for the Node Manager. The name must be between 8 and 128 characters long and cannot contain any of the following characters:
- Tab
- Brackets
- Parentheses
- The following special characters: left angle bracket (<), right angle bracket (>), ampersand (&), pound sign (#), pipe symbol (|), and question mark (?).
Response
- application/json
202 Response
Location
header returns a URI that can be used to view the job status. See View the Status of an Operation by Job Id.See Status Codes for information about other possible HTTP status codes.
object
issues
array for warning messages.-
details:
object details
Groups details of the operation.
object
-
issues(optional):
array issues
Groups strings of warning messages, if any.
-
jobId:
string
Job ID for the operation. Not available if the response status code is 400.
-
message:
string
System message that describes the operation.
Examples
The following example shows how to change the Node Manager credentials (user name and password) for an Oracle Java Cloud Service instance by submitting a POST request on the REST resource using cURL.
Note: The command in this example uses the URL structure https://rest_server_url/resource-path
, where rest_server_url
is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.
cURL Command
curl -i -X POST -u username:password -d @nmcredentials.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/credentials/update
Example of Request Body
The following shows an example of the request body for changing the Node Manager user name and password.
{
"components": {
"WLS": {
"nodeManagerUserName":"newusername",
"nodeManagerPassword":"newpassword"
}
}
}
Example of Response Header
The following shows an example of the response header. The Location
header returns the URI that can be used to view the job status. See View the Status of an Operation by Job Id.
HTTP/1.1 202 Accepted
Date: Tue, 21 Aug 2018 18:48:05 GMT
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/11779
Content-Length: 128
Content-Type: application/json
X-Frame-Options: DENY
Service-URI: https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/JaaS/instances/ExampleInstance
Retry-After: 60
Example of Response Body
The following shows an example of the response returned in JSON format.
{
"details":{
"message":"Submitted job to update [1] credential(s) for service [ExampleInstance] in domain [ExampleIdentityDomain].",
"jobId":"11779"
}
}