Documentation
¶
Index ¶
- Constants
- type AuthnChallengeRequest
- type AuthnChallengeRequiredResponse
- type AutoGenerated
- type BackupKey
- type BackupKeyReq
- type BepaResponseError
- type ChangePasswordReq
- type Group
- type GroupReq
- type GroupRes
- type GroupServiceUser
- type GroupUpdateReq
- type GroupUser
- type GroupUserRes
- type HealthCheckResponse
- type IdentifyAndAuthorizeReq
- type InvitationInfo
- type InviteUserReq
- type KiseSecret
- type OpenIDToken
- type Organization
- type PublicKey
- type PublicKeyReq
- type PublicKeyVerifyReq
- type RequestExecutionError
- type ResetPasswordReq
- type ResponseError
- type Role
- type RoleBinding
- type RoleBindingReq
- type RoleBindingRes
- type RoleCompactWorkspace
- type RoleReq
- type RoleRes
- type RoleWithCompactWorkspace
- type RoleWithItems
- type Rule
- type RuleReq
- type Service
- type ServiceUser
- type ServiceUserPublicKey
- type ServiceUserReq
- type ServiceUserToken
- type ServiceUserUpdateReq
- type ServiceUserWithCompactRole
- type ThirdParty
- type ThirdPartyAccessToken
- type ThirdPartyBulkRefreshToken
- type User
- type UserAcceptInvitationReq
- type UserCanReq
- type UserOtp
- type UserReq
- type UserRes
- type UserSecret
- type UserSecretRes
- type UserToken
- type UserTokenByCredsReq
- type UserTokenReq
- type UserUpdateReq
- type UserWithCompactRole
- type VerifRes
- type WebhookUser
- type WebhookUserWorkspaceRelation
- type WebhookWorkspace
- type WebhookWorkspaceOrganization
- type Workspace
- type WorkspaceReq
- type WorkspaceUpdateReq
- type WorkspaceWithOrganization
Constants ¶
View Source
const ( UserTypeUser = "user" UserTypeServiceUser = "service-user" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthnChallengeRequest ¶
type AuthnChallengeRequiredResponse ¶
type AuthnChallengeRequiredResponse struct {
ChallengeToken string `json:"challenge_token"`
ChallengeType string `json:"challenge_type"`
}
func (*AuthnChallengeRequiredResponse) Error ¶
func (r *AuthnChallengeRequiredResponse) Error() string
type AutoGenerated ¶
type BackupKeyReq ¶
type BepaResponseError ¶
type ChangePasswordReq ¶
type ChangePasswordReq struct {
Password string `json:"password" validate:"required,min=8"`
}
type Group ¶
type Group struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
Name string `json:"name"`
Description string `json:"description"`
Workspace Workspace `json:"workspace"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
UsersNumber int `json:"users_number,omitempty"`
ServiceUsersNumber int `json:"service_users_number,omitempty"`
Roles []RoleCompactWorkspace `json:"roles,omitempty"`
}
type GroupServiceUser ¶
type GroupServiceUser struct {
Group *Group `json:"group"`
ServiceUser *ServiceUser `json:"service_user"`
}
type GroupUpdateReq ¶
type GroupUpdateReq struct {
Name string `json:"name"`
Description string `json:"description"`
Workspace WorkspaceUpdateReq `json:"workspace"`
}
type GroupUserRes ¶
type HealthCheckResponse ¶
func (*HealthCheckResponse) String ¶
func (hcr *HealthCheckResponse) String() string
type IdentifyAndAuthorizeReq ¶
type InvitationInfo ¶
type InvitationInfo struct {
Token string `json:"invitation_token"`
}
type InviteUserReq ¶
type InviteUserReq struct {
Email string `json:"email" validate:"required,email"`
}
type KiseSecret ¶
type OpenIDToken ¶
type Organization ¶
type PublicKeyReq ¶
type PublicKeyVerifyReq ¶
type RequestExecutionError ¶
func (*RequestExecutionError) Error ¶
func (ree *RequestExecutionError) Error() string
type ResetPasswordReq ¶
type ResetPasswordReq struct {
Email string `json:"email" validate:"required,email"`
}
type ResponseError ¶
type Role ¶
type Role struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
DescriptionFa string `json:"description_fa"`
DescriptionEn string `json:"description_en"`
Workspace *Workspace `json:"workspace"`
Name string `json:"name"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Items []any `json:"items"`
}
type RoleBinding ¶
type RoleBindingReq ¶
type RoleBindingRes ¶
type RoleCompactWorkspace ¶
type RoleCompactWorkspace struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
DescriptionFa string `json:"description_fa"`
DescriptionEn string `json:"description_en"`
Workspace *uuid.UUID `json:"workspace"`
Name string `json:"name"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Items []any `json:"items"`
}
type RoleWithCompactWorkspace ¶
type RoleWithCompactWorkspace struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
DescriptionFa string `json:"description_fa"`
DescriptionEn string `json:"description_en"`
Workspace *uuid.UUID `json:"workspace"`
Name string `json:"name"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Items []any `json:"items"`
}
type RoleWithItems ¶
type ServiceUser ¶
type ServiceUser struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
Groups []Group `json:"groups"`
Description string `json:"description"`
ThirdParty *ThirdParty `json:"third_party,omitempty"`
Name string `json:"name"`
Workspace *uuid.UUID `json:"workspace"`
CreatedAt string `json:"created_at,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
Roles []*Role `json:"roles,omitempty"`
}
type ServiceUserPublicKey ¶
type ServiceUserPublicKey struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
ServiceUser string `json:"service_user"`
PublicKey string `json:"public_key"`
Name string `json:"name"`
CreatedAt string `json:"created_at,omitempty"`
Title string `json:"title"`
DeletedAt *time.Time `json:"deleted_at"`
Key string `json:"key"`
Type string `json:"type"`
}
type ServiceUserReq ¶
type ServiceUserToken ¶
type ServiceUserToken struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
ServiceUser string `json:"service_user"`
Secret string `json:"secret"`
Name string `json:"name"`
IsHashed bool `json:"is_hashed"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
ExpiresAt *time.Time `json:"expires_at"`
}
type ServiceUserUpdateReq ¶
type ServiceUserWithCompactRole ¶
type ServiceUserWithCompactRole struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
Groups []Group `json:"groups"`
Description string `json:"description"`
ThirdParty *ThirdParty `json:"third_party,omitempty"`
Name string `json:"name"`
Workspace *uuid.UUID `json:"workspace"`
CreatedAt string `json:"created_at,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
Roles []*RoleCompactWorkspace `json:"roles,omitempty"`
}
type ThirdParty ¶
type ThirdPartyAccessToken ¶
type ThirdPartyAccessToken struct {
UUID string `json:"uuid"`
AccessToken string `json:"access_token"`
ExpiresAt *time.Time `json:"expires_at,omitempty"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
ThirdPartyUUID string `json:"third_party_uuid"`
OrganizationUUID string `json:"organization_uuid"`
}
type ThirdPartyBulkRefreshToken ¶
type ThirdPartyBulkRefreshToken struct {
UUID string `json:"uuid"`
RefreshToken string `json:"refresh_token"`
ExpiresAt *time.Time `json:"expires_at,omitempty"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
ServiceUserUUID string `json:"service_user_uuid"`
ThirdPartyUUID string `json:"third_party_uuid"`
WorkspaceUUID string `json:"workspace_uuid"`
}
type User ¶
type User struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
Name string `json:"name"`
Email string `json:"email"`
InvitationToken string `json:"invitation_token,omitempty"`
Groups []Group `json:"groups"`
Roles []Role `json:"roles"`
EmailVerified bool `json:"email_verified"`
PhoneNumber string `json:"phone_number,omitempty"`
PhoneNumberVerified bool `json:"phone_number_verified"`
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Birthday string `json:"birthday,omitempty"`
IsSuspended bool `json:"is_suspended"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
UserType string `json:"user_type"`
IsOtpEnabled bool `json:"is_otp_enabled"`
}
type UserAcceptInvitationReq ¶
type UserCanReq ¶
type UserCanReq struct {
Path string `json:"path" validate:"required"`
}
type UserRes ¶
type UserRes struct {
UUID string `json:"uuid"`
Name string `json:"name"`
Email string `json:"email"`
UserType string `json:"user_type"`
IsSuspended bool `json:"is_suspended"`
Workspaces []string `json:"workspaces"`
CreatedAt time.Time `json:"created_at,omitempty"`
UpdatedAt time.Time `json:"updated_at,omitempty"`
InvitationToken string `json:"invitation_token,omitempty"`
Items []map[string]string `json:"items,omitempty"`
ThirdParty ThirdParty `json:"third_party,omitempty"`
}
type UserSecret ¶
type UserSecret struct {
Secret string `json:"secret"`
}
type UserSecretRes ¶
type UserSecretRes struct {
Secret string `json:"secret"`
}
type UserToken ¶
type UserToken struct {
UUID string `json:"uuid"`
Name string `json:"name"`
User string `json:"user"`
Secret string `json:"secret"`
IsHashed bool `json:"is_hashed"`
Active bool `json:"active"`
LastAccessAt *time.Time `json:"last_access_at"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
DeletedAt *time.Time `json:"deleted_at"`
ExpiresAt *time.Time `json:"expires_at"`
}
type UserTokenByCredsReq ¶
type UserTokenReq ¶
type UserUpdateReq ¶
type UserWithCompactRole ¶
type UserWithCompactRole struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
Name string `json:"name"`
Email string `json:"email"`
InvitationToken string `json:"invitation_token,omitempty"`
Groups []Group `json:"groups"`
Roles []RoleCompactWorkspace `json:"roles"`
EmailVerified bool `json:"email_verified"`
PhoneNumber string `json:"phone_number,omitempty"`
PhoneNumberVerified bool `json:"phone_number_verified"`
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Birthday string `json:"birthday,omitempty"`
IsSuspended bool `json:"is_suspended"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
UserType string `json:"user_type"`
IsOtpEnabled bool `json:"is_otp_enabled"`
}
type WebhookUser ¶
type WebhookUser struct {
UUID uuid.UUID `json:"uuid"`
Name string `json:"name"`
Email string `json:"email"`
IsEmailVerified bool `json:"email_verified"`
PhoneNumber string `json:"phone_number"`
IsPhoneNumberVerified bool `json:"phone_number_verified"`
FirstName string `json:"first_name"`
LastName string `json:"last_name"`
Birthday string `json:"birthday"`
IsSuspended bool `json:"is_suspended"`
}
type WebhookWorkspace ¶
type WebhookWorkspace struct {
UUID uuid.UUID `json:"uuid"`
Name string `json:"name"`
IsSuspended bool `json:"is_suspended"`
Organization Organization `json:"organization"`
}
type Workspace ¶
type Workspace struct {
UUID *uuid.UUID `json:"uuid" faker:"uuidObject"`
Name string `json:"name"`
Namespace string `json:"namespace"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Organization *uuid.UUID `json:"organization" faker:"uuidObject"`
IsSuspended bool `json:"is_suspended"`
}
type WorkspaceReq ¶
type WorkspaceReq struct {
Name string `json:"name" validate:"required,rfc1123_label"`
}
type WorkspaceUpdateReq ¶
Click to show internal directories.
Click to hide internal directories.