models

package
v1.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 3, 2025 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DefaultAdminRoles = []string{"DpaAdmin", "global auditor", "System Administrator"}

DefaultAdminRoles defines the default roles for an admin user.

Functions

This section is empty.

Types

type ArkIdentityCreateUser

type ArkIdentityCreateUser struct {
	Username     string   `json:"username" mapstructure:"username" flag:"username" desc:"Name of the user to create"`
	DisplayName  string   `json:"display_name,omitempty" mapstructure:"display_name" flag:"display-name" desc:"Display name of the user"`
	Email        string   `json:"email,omitempty" mapstructure:"email" flag:"email" desc:"Email of the user"`
	MobileNumber string   `json:"mobile_number,omitempty" mapstructure:"mobile_number" flag:"mobile-number" desc:"Mobile number of the user"`
	Suffix       string   `json:"suffix,omitempty" mapstructure:"suffix" flag:"suffix" desc:"Suffix to use for the username"`
	Password     string   `json:"password" mapstructure:"password" flag:"password" desc:"Password of the user"`
	Roles        []string `` /* 137-byte string literal not displayed */
}

ArkIdentityCreateUser represents the schema for creating a user. Note that username,display_name,email,mobile_number, and password will be auto generated if not given

type ArkIdentityDeleteUser

type ArkIdentityDeleteUser struct {
	UserID   string `json:"user_id,omitempty" mapstructure:"user_id" flag:"user-id" desc:"User ID to delete"`
	Username string `json:"username,omitempty" mapstructure:"username" flag:"username" desc:"Username to delete"`
}

ArkIdentityDeleteUser represents the schema for deleting a user.

type ArkIdentityDeleteUsers

type ArkIdentityDeleteUsers struct {
	UserIDs []string `json:"user_ids" mapstructure:"user_ids" flag:"user-ids" desc:"User IDs to delete" required:"true"`
}

ArkIdentityDeleteUsers represents the schema for deleting multiple users.

type ArkIdentityResetUserPassword

type ArkIdentityResetUserPassword struct {
	Username    string `json:"username" mapstructure:"username" flag:"username" desc:"Username to reset the password for" required:"true"`
	NewPassword string `json:"new_password" mapstructure:"new_password" flag:"new-password" desc:"New password to reset to" required:"true"`
}

ArkIdentityResetUserPassword represents the schema for resetting a user's password.

type ArkIdentityUpdateUser

type ArkIdentityUpdateUser struct {
	UserID       string `json:"user_id,omitempty" mapstructure:"user_id" flag:"user-id" desc:"Users id that we change the details for"`
	Username     string `json:"username,omitempty" mapstructure:"username" flag:"username" desc:"Username that we change the details for"`
	NewUsername  string `json:"new_username,omitempty" mapstructure:"new_username" flag:"new-username" desc:"Name of the user to change"`
	DisplayName  string `json:"display_name,omitempty" mapstructure:"display_name" flag:"display-name" desc:"Display name of the user to change"`
	Email        string `json:"email,omitempty" mapstructure:"email" flag:"email" desc:"Email of the user to change"`
	MobileNumber string `json:"mobile_number,omitempty" mapstructure:"mobile_number" flag:"mobile-number" desc:"Mobile number of the user to change"`
}

ArkIdentityUpdateUser represents the schema for updating a user's details.

type ArkIdentityUser

type ArkIdentityUser struct {
	UserID       string     `json:"user_id" mapstructure:"user_id" flag:"user-id" desc:"User identifier"`
	Username     string     `json:"username" mapstructure:"username" flag:"username" desc:"Name of the user"`
	DisplayName  string     `json:"display_name,omitempty" mapstructure:"display_name" flag:"display-name" desc:"Display name of the user"`
	Email        string     `json:"email,omitempty" mapstructure:"email" flag:"email" desc:"Email of the user"`
	MobileNumber string     `json:"mobile_number,omitempty" mapstructure:"mobile_number" flag:"mobile-number" desc:"Mobile number of the user"`
	Roles        []string   `json:"roles,omitempty" mapstructure:"roles" flag:"roles" desc:"Roles of the user"`
	LastLogin    *time.Time `json:"last_login,omitempty" mapstructure:"last_login" flag:"last-login" desc:"Last login of the user"`
}

ArkIdentityUser represents the schema for a user.

type ArkIdentityUserByID

type ArkIdentityUserByID struct {
	UserID string `json:"user_id" mapstructure:"user_id" flag:"user-id" desc:"Id to find the user for" required:"true"`
}

ArkIdentityUserByID represents the schema for finding a user by ID.

type ArkIdentityUserByName

type ArkIdentityUserByName struct {
	Username string `json:"username" mapstructure:"username" flag:"username" desc:"User name to find the id for" required:"true"`
}

ArkIdentityUserByName represents the schema for finding a user by their username.

type ArkIdentityUserIDByName

type ArkIdentityUserIDByName struct {
	Username string `json:"username" mapstructure:"username" flag:"username" desc:"User name to find the id for" required:"true"`
}

ArkIdentityUserIDByName represents the schema for finding a user ID by their username.

type ArkIdentityUserInfo

type ArkIdentityUserInfo struct {
	FirstName  string                   `json:"first_name" mapstructure:"first_name" flag:"first-name" desc:"First name of the user"`
	LastName   string                   `json:"last_name" mapstructure:"last_name" flag:"last-name" desc:"Last name of the user"`
	HomeNumber string                   `json:"home_number" mapstructure:"home_number" flag:"home-number" desc:"Home number of the user"`
	Manager    string                   `json:"manager" mapstructure:"manager" flag:"manager" desc:"Manager of the user"`
	Username   string                   `json:"username" mapstructure:"username" flag:"username" desc:"Username info"`
	Groups     []map[string]interface{} `json:"groups" mapstructure:"groups" flag:"groups" desc:"AD groups of the user"`
	Rights     []string                 `json:"rights" mapstructure:"rights" flag:"rights" desc:"Administrative rights of the user"`
	Roles      []map[string]interface{} `json:"roles" mapstructure:"roles" flag:"roles" desc:"Roles of the user"`
}

ArkIdentityUserInfo represents the schema for user information.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL