The Password Controller manages authentication credentials for publicly accessible resources such as Dropsites and Press Areas. This controller handles symmetric passwords that are visible to all users with access permissions to the specific mediacontainer. Password protection provides a simple and effective way to control access to external-facing content while maintaining ease of use.
Security Considerations
- Passwords set through this controller are symmetric, meaning they are shared among all authorized users.
- All users with access to the mediacontainer can view the configured password.
- Consider implementing regular password rotation for sensitive resources.
- The system does not enforce password complexity requirements through the API; implementing strong password policies is recommended at the application level.
Reference
Find Password
This endpoint allows you to view password details for a specific protected page or resource. It requires both the resource identifier and type to locate the correct password entry. Use this endpoint when you need to verify or share existing password information with authorized users.
Field | Type | Required | Description |
---|---|---|---|
mediaContainerId | integer | ✓ | ID of the protected resource |
type | string | ✓ | Type of the protected resource |
Create Password
Use this endpoint to set up password protection for a resource such as a Dropsite or Press Area. Once configured, the specified resource will require password authentication before granting access to visitors. The password is symmetric and will be visible to all users who have access to the mediacontainer in the AdmiralCloud system.
Field | Type | Required | Description |
---|---|---|---|
mediaContainerId | integer | ✓ | ID of the protected resource |
password | string | ✓ | Password for the protected resource |
type | string | ✓ | Type of the protected resource |
Destroy Password
This endpoint allows you to disable password protection for a previously secured resource. After successful execution, the resource will become accessible without password authentication. This operation requires verification of the existing password to prevent unauthorized removal of security measures.
Field | Type | Required | Description |
---|---|---|---|
mediaContainerId | integer | ✓ | ID of the protected resource |
password | string | ✓ | Password for the protected resource |
type | string | ✓ | Type of the protected resource |