Reset Password Link
This chapter describes the rpl resource, properties and operations.
Overview
reset password link id instances are used to reset passwords for appliance users.
Resource Properties
An reset password link request instance is represented by the following fields.
Type values are described in Data types.
| Name | Type | Description |
|---|---|---|
| id | String | The user that raised the request. |
| requested | String | The date and time when request was raised. |
| expires | String | The date and time when request expires. |
| status | String | The status of request (open or link created). |
Resource Operations
- Retrieve a list of reset password requests
- Retrieve a reset password link id for a user
- Raise a request for Reset Password Link id
- Generate Reset Password Link id
- Validate Reset Password Link id
- Reset Password
Retrieve a list of reset password requests
Use this operation to retrieve a list of reset password requests raised by users.
Authentication/Authorization
The caller must provide a API token, refer to Invoking API operations.
The user represented by the API token must have the following role:
admin
Network
This operation is available from the following network(s):
management
HTTP Method and URI
GET /api/com.ibm.zaci.system/rpl
Query Parameters
None
Request headers
For the list of required headers, refer to the Invoking API operations section.
The following sections describe the acceptable values for certain headers.
Accept media types
Request message body
None
Response
An HTTP status code of 200 indicates a successful operation. The response message body contains data formatted as requested in the Accept header, with kind=collection. The instances array contains zero or more objects,
as described under the Resource Properties topic.
Any other HTTP status code indicates a failed operation. Refer to Common request validation reason codes for a list of common HTTP status codes and associated IBM Secure Service Container for IBM Cloud Private System API reason codes.
Example
Request
GET /api/com.ibm.zaci.system/rpl HTTP/1.1
Host: 9.9.9.9:443
Authorization: Bearer qwert.asdfg.zxcvb
zACI-API: com.ibm.zaci.system/1.0
Accept: application/vnd.ibm.zaci.payload+json;version=1.0
Response
HTTP/1.1 200 OK
Date: Tue, 15 May 2015 08:12:31 GMT
zACI-API: com.ibm.zaci.system/1.0
Content-Type: application/vnd.ibm.zaci.payload+json;version=1.0
Content-Length: 439
{
"kind": "collection",
"self": "/api/com.ibm.zaci.system/rpl",
"namespace": "com.ibm.zaci.system",
"namespace-version": "1.0",
"resource": "rpl",
"instances": [
{
"id": "kready",
"requested": "2017-01-06 06:48:50",
"expires": "",
"status": "open"
},
{
"id": "abdul",
"requested": "2017-01-05 06:48:50",
"expires": "2017-01-06 06:48:50",
"status": "link created"
},
]
}
Retrieve a reset password link id for a user
Use this operation to get a Reset Password Link id for given user.
Authentication/Authorization
The caller must provide a API token, refer to Invoking API operations.
The user represented by the API token must have the following role:
admin
Network
This operation is available from the following network(s):
management
HTTP Method and URI
GET /api/com.ibm.zaci.system/rpl
Query Parameters
| Name | Type | Rqd/Opt | Description |
|---|---|---|---|
| user | String | Rqd | The user whose reset password link id we want to get |
Request headers
For the list of required headers, refer to the Invoking API operations section.
The following sections describe the acceptable values for certain headers.
Accept media types
Request message body
None
Response
An HTTP status code of 200 indicates a successful operation. The response message body contains data formatted as requested in the Accept header, with kind=instance. The properties array contents are as described below:
| Name | Type | Description |
|---|---|---|
| id | String | The user that raised the request. |
| rpl | String | The reset password link id of the user. |
| expires | String | The expiration time of the link. |
Any other HTTP status code indicates a failed operation. Refer to Common request validation reason codes for a list of common HTTP status codes and associated IBM Secure Service Container for IBM Cloud Private System API reason codes.
Example
Request
GET /api/com.ibm.zaci.system/rpl?user=abdul HTTP/1.1
Host: 9.9.9.9:443
Authorization: Bearer qwert.asdfg.zxcvb
zACI-API: com.ibm.zaci.system/1.0
Accept: application/vnd.ibm.zaci.payload+json;version=1.0
Response
HTTP/1.1 200 OK
Date: Tue, 15 May 2015 08:12:31 GMT
zACI-API: com.ibm.zaci.system/1.0
Content-Type: application/vnd.ibm.zaci.payload+json;version=1.0
Content-Length: 439
{
"kind": "instance",
"self": "/api/com.ibm.zaci.system/rpl",
"namespace": "com.ibm.zaci.system",
"namespace-version": "1.0",
"resource": "rpl",
"properties": [
{
"id": "abdul",
"rpl": "sxL0epAtRbRsdEhXHsyD",
"expires": "2017-04-10 15:19:06"
}
]
}
Raise a request for Reset Password Link id
Use this operation to raise a request for Reset Password Link id.
Network
This operation is available from the following network(s):
management
HTTP Method and URI
PUT /api/com.ibm.zaci.system/rpl
Query Parameters
None
Request headers
For the list of required headers, refer to the Invoking API operations section.
The following sections describe the acceptable values for certain headers.
Content-type media types
Request message body
The request message body must contain data formatted as specified in the Content-type header, with kind=request. The format of the parameters object is described in the following table.
| Name | Type | Rqd/Opt | Description |
|---|---|---|---|
| operation | String | Rqd | The value of operation must be raise-request for this case |
| user | String | Rqd | The appliance user who wants to raise this request |
Response
An HTTP status code of 204 indicates a successful operation.
Any other HTTP status code indicates a failed operation. Refer to Common request validation reason codes for a list of common HTTP status codes and associated IBM Secure Service Container for IBM Cloud Private System API reason codes.
Example
Request
PUT /api/com.ibm.zaci.system/rpl HTTP/1.1
Host: 9.9.9.9:443
zACI-API: com.ibm.zaci.system/1.0
Content-type: application/vnd.ibm.zaci.payload+json;version=1.0
Content-length:200
{
"kind": "request",
"parameters": {
"operation": "raise-request",
"user": "abdul"
}
}
Response
HTTP/1.1 204 NO CONTENT
Date: Tue, 15 May 2015 08:12:31 GMT
zACI-API: com.ibm.zaci.system/1.0
Generate Reset Password Link id
Use this operation to generate a Reset Password Link id.
Authentication/Authorization
The caller must provide a API token, refer to Invoking API operations.
The user represented by the API token must have the following role:
admin
Network
This operation is available from the following network(s):
management
HTTP Method and URI
POST /api/com.ibm.zaci.system/rpl
Query Parameters
None
Request headers
For the list of required headers, refer to the Invoking API operations section.
The following sections describe the acceptable values for certain headers.
Accept media types
Content-type media types
Request message body
The request message body must contain data formatted as specified in the Content-type header, with kind=request. The format of the parameters object is described in the following table.
| Name | Type | Rqd/Opt | Description |
|---|---|---|---|
| operation | String | Rqd | The value of operation must be gen-rpl for this case |
| user | String | Rqd | The appliance user for whom the admin wants to generate a Reset Password Link id |
Response
An HTTP status code of 200 indicates a successful operation.
Any other HTTP status code indicates a failed operation. Refer to Common request validation reason codes for a list of common HTTP status codes and associated IBM Secure Service Container for IBM Cloud Private System API reason codes.
Example
Request
POST /api/com.ibm.zaci.system/rpl HTTP/1.1
Host: 9.9.9.9:443
Authorization: Bearer qwert.asdfg.zxcvb
zACI-API: com.ibm.zaci.system/1.0
Accept: application/vnd.ibm.zaci.payload+json;version=1.0
Content-type: application/vnd.ibm.zaci.payload+json;version=1.0
Content-length:200
{
"kind": "request",
"parameters": {
"operation": "gen-rpl",
"user": "abdul"
}
}
Response
HTTP/1.1 200
Date: Tue, 15 May 2015 08:12:31 GMT
zACI-API: com.ibm.zaci.system/1.0
Content-type: application/vnd.ibm.zaci.payload+json;version=1.0
Content-length:200
{
"kind": "instance",
"resource-version": "1.0",
"properties": {
"rpl": "sxL0epAtRbRsdEhXHsyD"
},
"self": "/api/com.ibm.zaci.system/rpl",
"resource-name": "rpl"
}
Validate Reset Password Link id
Use this operation to validate a Reset Password Link id.
Network
This operation is available from the following network(s):
management
HTTP Method and URI
PUT /api/com.ibm.zaci.system/rpl
Query Parameters
None
Request headers
For the list of required headers, refer to the Invoking API operations section.
The following sections describe the acceptable values for certain headers.
Content-type media types
Request message body
The request message body must contain data formatted as specified in the Content-type header, with kind=request. The format of the parameters object is described in the following table.
| Name | Type | Rqd/Opt | Description |
|---|---|---|---|
| operation | String | Rqd | The value of operation must be validate-rpl for this case |
| rpl | String | Rqd | The Reset Password Link id to be validated |
| user | String | Rqd | The appliance user who wants to validate a Reset Password Link id |
Response
An HTTP status code of 204 indicates a successful operation.
Any other HTTP status code indicates a failed operation. Refer to Common request validation reason codes for a list of common HTTP status codes and associated IBM Secure Service Container for IBM Cloud Private System API reason codes.
Example
Request
PUT /api/com.ibm.zaci.system/rpl HTTP/1.1
Host: 9.9.9.9:443
zACI-API: com.ibm.zaci.system/1.0
Content-type: application/vnd.ibm.zaci.payload+json;version=1.0
Content-length:200
{
"kind": "request",
"parameters": {
"operation": "validate-rpl",
"user": "abdul",
"rpl": "sxL0epAtRbRsdEhXHsyD"
}
}
Response
HTTP/1.1 204 NO CONTENT
Date: Tue, 15 May 2015 08:12:31 GMT
zACI-API: com.ibm.zaci.system/1.0
Reset Password
Use this operation to reset password for a user.
Network
This operation is available from the following network(s):
management
HTTP Method and URI
PUT /api/com.ibm.zaci.system/rpl
Query Parameters
None
Request headers
For the list of required headers, refer to the Invoking API operations section.
The following sections describe the acceptable values for certain headers.
Content-type media types
Request message body
The request message body must contain data formatted as specified in the Content-type header, with kind=request. The format of the parameters object is described in the following table.
| Name | Type | Rqd/Opt | Description |
|---|---|---|---|
| operation | String | Rqd | The value of operation must be reset-pswd for this case |
| new-pswd | String | Rqd | The new password of the user |
| user | String | Rqd | The appliance user who wishes to reset the password |
| rpl | String | Rqd | The Reset Password Link id to reset the password. |
Response
An HTTP status code of 204 indicates a successful operation.
Any other HTTP status code indicates a failed operation. Refer to Common request validation reason codes for a list of common HTTP status codes and associated IBM Secure Service Container for IBM Cloud Private System API reason codes.
Example
Request
PUT /api/com.ibm.zaci.system/rpl HTTP/1.1
Host: 9.9.9.9:443
zACI-API: com.ibm.zaci.system/1.0
Content-type: application/vnd.ibm.zaci.payload+json;version=1.0
Content-length:200
{
"kind": "request",
"parameters": {
"operation": "reset-pswd",
"new-pswd": "passw0rd",
"user": "abdul",
"rpl": "sxL0epAtRbRsdEhXHsyD"
}
}
Response
HTTP/1.1 204 NO CONTENT
Date: Tue, 15 May 2015 08:12:31 GMT
zACI-API: com.ibm.zaci.system/1.0