BrokerOAuth2ClientStartSecretRotationMedia

BrokerOAuth2ClientStartSecretRotationMedia
BrokerOAuth2ClientStartSecretRotationMedia

Media for OAuth 2.0 client start secret rotation action.

JSON Example
{
    "_links": {
        "self": {
            "href": "https://example.com/path-to-self"
        }
    },
    "primary_secret_auto_retire_duration": 2880,
    "secondary_secret": "MySecret@#$"
}
object
_links
Optional

The resource HATEOAS links. Usually includes a "self" link for this resource

integer As int32 As int32
primary_secret_auto_retire_duration
Optional
Constraints: minimum: 0 maximum: 10080 default: 1440

Indicates how long in minutes until primary secret will retire automatically. Default value if not specified is 1 day. Maximum value is 7 days. The field is optional when starting a secret rotation and it is ignored when ending a rotation. Notice there is a potential delay up to 1 hour for this auto retire to take effect. For example, if you set auto retire after 10 minutes, it's possible that the primary secret will actually be retired up to 10 minutes plus 1 hour

string
secondary_secret
Optional
Constraints: minLength: 0 maxLength: 4096

An alternative secret to the client primary secret that will replace the existing primary secret when the secret rotation ends. The field is mandatory when starting a secret rotation and it is ignored when ending a rotation.

Parameter To
Returned By