Skip to main content

Manage Security

AMPS provides modules for managing the security features of an instance.

Authentication and entitlement can be enabled or disabled, which is useful for debugging or auditing purposes. You can also reset security and authentication, which clears the AMPS internal caches and gives security and authentication modules the opportunity to reinitialize themselves, for example, by re-parsing an entitlements file.

AMPS loads the following modules by default:

Module NameDoes
amps-action-do-disable-authenticationDisables authentication for the instance.
amps-action-do-disable-entitlementDisables entitlement for the instance.
amps-action-do-enable-authenticationEnables authentication for the instance.
amps-action-do-enable-entitlementEnables entitlement for the instance.
amps-action-do-reset-authenticationResets authentication by clearing AMPS caches and reinitializing authentication.
amps-action-do-reset-entitlementResets entitlement by clearing AMPS caches and reinitializing entitlement.

These modules require no parameters. The amps-action-do-reset-authentication module and the amps-action-do-reset-entitlement module accept an optional Transport parameter which specifies the transport to reset.

ParameterDescription
Transport

The name of the transport for which to reset authentication or entitlements.

If no name is provided, these modules affect all transports.

AuthenticationId

The authentication ID of the client for which to reset entitlements.

If no ID is provided, these modules affect all clients.

These modules do not add any variables to the AMPS context.