Documentation
¶
Index ¶
- type AssignRoleRequest
- type CreateResourceRequest
- type CreateRoleRequest
- type GrantPermissionRequest
- type LocalBackendPayload
- type PasswordChangePayload
- type PasswordResetPayload
- type PasswordResetVerifyPayload
- type RefreshTokenPayload
- type RevokePermissionRequest
- type UpdateResourceRequest
- type UpdateRoleRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssignRoleRequest ¶
type AssignRoleRequest struct {
UserID string `json:"userID" binding:"required"`
ExpiresAt *time.Time `json:"expiresAt"`
} // @name AssignRoleRequest
AssignRoleRequest is the payload for POST /auth/roles/:name/assignments.
type CreateResourceRequest ¶
type CreateResourceRequest struct {
Name string `json:"name" binding:"required"`
Description string `json:"description"`
Actions []string `json:"actions"`
} // @name CreateResourceRequest
CreateResourceRequest is the payload for POST /auth/resources.
type CreateRoleRequest ¶
type CreateRoleRequest struct {
Name string `json:"name" binding:"required"`
Description string `json:"description"`
Metadata map[string]interface{} `json:"metadata"`
} // @name CreateRoleRequest
CreateRoleRequest is the payload for POST /auth/roles.
type GrantPermissionRequest ¶
type GrantPermissionRequest struct {
Resource string `json:"resource" binding:"required"`
Action string `json:"action" binding:"required"`
} // @name GrantPermissionRequest
GrantPermissionRequest is the payload for POST /auth/roles/:name/permissions.
type LocalBackendPayload ¶
type PasswordChangePayload ¶
type PasswordChangePayload struct {
CurrentPassword string `json:"currentPassword" binding:"required"`
NewPassword string `json:"newPassword" binding:"required,min=8"`
} // @name PasswordChangePayload
PasswordChangePayload represents a request to change password
type PasswordResetPayload ¶
type PasswordResetPayload struct {
Email string `json:"email" binding:"required,email"`
} // @name PasswordResetPayload
PasswordResetPayload represents a request to reset password
type PasswordResetVerifyPayload ¶
type PasswordResetVerifyPayload struct {
Token string `json:"token" binding:"required"`
Password string `json:"password" binding:"required,min=8"`
} // @name PasswordResetVerifyPayload
PasswordResetVerifyPayload represents a request to verify password reset token
type RefreshTokenPayload ¶
type RefreshTokenPayload struct {
RefreshToken string `json:"refreshToken" binding:"required"`
} // @name RefreshTokenPayload
type RevokePermissionRequest ¶
type RevokePermissionRequest struct {
Resource string `json:"resource" binding:"required"`
Action string `json:"action" binding:"required"`
} // @name RevokePermissionRequest
RevokePermissionRequest is the payload for DELETE /auth/roles/:name/permissions.
type UpdateResourceRequest ¶
type UpdateResourceRequest struct {
Description string `json:"description"`
Actions []string `json:"actions"`
} // @name UpdateResourceRequest
UpdateResourceRequest is the payload for PATCH /auth/resources/:name — name itself is not updatable, see ResourceRepository.UpdateResource's doc comment.
type UpdateRoleRequest ¶
type UpdateRoleRequest struct {
Description string `json:"description"`
Metadata map[string]interface{} `json:"metadata"`
} // @name UpdateRoleRequest
UpdateRoleRequest is the payload for PATCH /auth/roles/:name — name itself is not updatable, see RoleRepository.UpdateRole's doc comment.
Source Files