PUT v1/bunits/{bunitId}/nodepasswordrule

Updates an existing password rule.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId The ID of the business unit of the password rule integer

Required

Body Parameters

the updated password rule object

NodePasswordRule
NameDescriptionTypeAdditional information
Type The type of the password rule
Options are:
PrefixNodeId = 1, NodeIdPostfix = 2, Generated = 3, Static = 4
PasswordRuleType

None.

Text The text used when creating a password. This text is used according to the type of rule
string

None.

MinimumLength If type is generated, the minimum length defines
integer

None.

PasswordExpirationDays Sets the PassExp property in IBM Storage Protect when activating a backup node
Set to 0 (zero) for undefined
integer

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<NodePasswordRule xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>4</Id>
  <CreatedDate>2024-05-20T17:08:21.3156446+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T17:08:21.3156446+02:00</ArchivedDate>
  <Type>
    <Id>2</Id>
    <CreatedDate>2024-05-20T17:08:21.3156446+02:00</CreatedDate>
    <ArchivedDate>2024-05-20T17:08:21.3156446+02:00</ArchivedDate>
    <Name>sample string 1</Name>
  </Type>
  <Text>sample string 1</Text>
  <MinimumLength>2</MinimumLength>
  <PasswordExpirationDays>3</PasswordExpirationDays>
</NodePasswordRule>

Response Information

Resource Description

The updated password rule

NodePasswordRule
NameDescriptionTypeAdditional information
Type The type of the password rule
Options are:
PrefixNodeId = 1, NodeIdPostfix = 2, Generated = 3, Static = 4
PasswordRuleType

None.

Text The text used when creating a password. This text is used according to the type of rule
string

None.

MinimumLength If type is generated, the minimum length defines
integer

None.

PasswordExpirationDays Sets the PassExp property in IBM Storage Protect when activating a backup node
Set to 0 (zero) for undefined
integer

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<NodePasswordRule xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>4</Id>
  <CreatedDate>2024-05-20T17:08:21.3156446+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T17:08:21.3156446+02:00</ArchivedDate>
  <Type>
    <Id>2</Id>
    <CreatedDate>2024-05-20T17:08:21.3156446+02:00</CreatedDate>
    <ArchivedDate>2024-05-20T17:08:21.3156446+02:00</ArchivedDate>
    <Name>sample string 1</Name>
  </Type>
  <Text>sample string 1</Text>
  <MinimumLength>2</MinimumLength>
  <PasswordExpirationDays>3</PasswordExpirationDays>
</NodePasswordRule>