roles

Patches a specified role

Updates the role and returns the updated definition

patch/accounts/{id}/roles/{role_id}

Path parameters

idstring required

Account id

role_idstring required

Role id

Request body

namestring

Name of the role

descriptionstring

Description of the role

maximum_auth_age_secsinteger

An integer of value 1 or more.

mfa_requiredboolean

Determines if this role requires multi-factor authentication

inheritableboolean

Determines if this role is inheritable by the subaccounts of the account in which it was created

Response

The role was successfully updated

namestring

Name of the role

descriptionstring

Description of the role

maximum_auth_age_secsinteger

An integer of value 1 or more.

mfa_requiredboolean

Determines if this role requires multi-factor authentication

inheritableboolean

Determines if this role is inheritable by the subaccounts of the account in which it was created

hrefstring

A reference to this role

createdstring

An iso8601 formatted timestamp

updatedstring

An iso8601 formatted timestamp

Changes

No recorded changes to this endpoint across all 1 revision of this API.