Update Admin Message Metadata.

Prev Next
Put
/admin-messages/{id}

Update the metadata of an Admin Message.

Security
HTTP
Type bearer
Path parameters
id
string

The UUID of the Admin Message Metadata.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
Body parameters
object
id
string

The uuid of the message metadata.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
message
string Required

The message text.

ExampleIdentity Provider "local" does not have IP Pool assigned.
status
string Required

The status of the message.

Valid values[ "Unresolved", "Resolved", "Muted" ]
appliedAt
string (date-time)

When the message metadata was updated.

Example2020-01-01T12:00:00Z
appliedBy
string

The distinguished name of who updated the message metadata.

ExampleCN=4c07bc6757ea42ddb702c2d6c45419fc,CN=admin,OU=local
appliedByUsername
string

The username of the user who updated the message metadata.

Exampleadmin
appliedByProviderName
string

The provider name of the user who updated the message metadata.

Examplelocal
appliedByDeviceId
string (uuid)

The device ID of the user who updated the message metadata.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
Responses
200

The updated Admin Message Metadata.

object
id
string

The uuid of the message metadata.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
message
string

The message text.

ExampleIdentity Provider "local" does not have IP Pool assigned.
status
string

The status of the message.

Valid values[ "Unresolved", "Resolved", "Muted" ]
appliedAt
string (date-time)

When the message metadata was updated.

Example2020-01-01T12:00:00Z
appliedBy
string

The distinguished name of who updated the message metadata.

ExampleCN=4c07bc6757ea42ddb702c2d6c45419fc,CN=admin,OU=local
appliedByUsername
string

The username of the user who updated the message metadata.

Exampleadmin
appliedByProviderName
string

The provider name of the user who updated the message metadata.

Examplelocal
appliedByDeviceId
string (uuid)

The device ID of the user who updated the message metadata.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.