Update Access Key

put

Updates an access key specified by an access key id.

Authorizations
AuthorizationstringRequired

Enter the Bearer Authorization string as following: Bearer Generated-JWT-Token

Path parameters
accessKeyIdstring · uuidRequired
Body

Contains details for updating an existing access key.

pinstring | nullableOptional

(optional) A PIN that should be used with the access key. Only applicable for rfid access key types.

accessesstring · uuid[] | nullableOptional

(optional) A list of accesses, specified by id, that should be authorized to the access key. If omitted, the current access assignments will not be changed.

updateValidityPeriodbooleanOptional

Indicates if the validity period should be updated. If set to false, validFrom and validTo will be ignored.

validFromstring | nullableOptional

(optional) ISO 8601 formatted date from where the access key becomes active. If omitted, the access key will be active immediately after creation. Only applicable if updateValidityPeriod is set to true.

validTostring | nullableOptional

(optional) ISO 8601 formatted date from where the access key expires. If omitted, the access key will never expire. Only applicable if updateValidityPeriod is set to true.

Responses
put
/integrator/v1/accesskeys/{accessKeyId}

Last updated