Documentation
¶
Index ¶
- Variables
- type ArkIdentityUsersService
- func (s *ArkIdentityUsersService) CreateUser(createUser *usersmodels.ArkIdentityCreateUser) (*usersmodels.ArkIdentityUser, error)
- func (s *ArkIdentityUsersService) DeleteUser(deleteUser *usersmodels.ArkIdentityDeleteUser) error
- func (s *ArkIdentityUsersService) DeleteUsers(deleteUsers *usersmodels.ArkIdentityDeleteUsers) error
- func (s *ArkIdentityUsersService) ResetUserPassword(resetUserPassword *usersmodels.ArkIdentityResetUserPassword) error
- func (s *ArkIdentityUsersService) ServiceConfig() services.ArkServiceConfig
- func (s *ArkIdentityUsersService) UpdateUser(updateUser *usersmodels.ArkIdentityUpdateUser) error
- func (s *ArkIdentityUsersService) UserByID(userByID *usersmodels.ArkIdentityUserByID) (*usersmodels.ArkIdentityUser, error)
- func (s *ArkIdentityUsersService) UserByName(user *usersmodels.ArkIdentityUserByName) (*usersmodels.ArkIdentityUser, error)
- func (s *ArkIdentityUsersService) UserIDByName(user *usersmodels.ArkIdentityUserIDByName) (string, error)
- func (s *ArkIdentityUsersService) UserInfo() (*usersmodels.ArkIdentityUserInfo, error)
Constants ¶
This section is empty.
Variables ¶
var IdentityUsersServiceConfig = services.ArkServiceConfig{ ServiceName: "identity-users", RequiredAuthenticatorNames: []string{"isp"}, OptionalAuthenticatorNames: []string{}, }
IdentityUsersServiceConfig is the configuration for the identity users service.
Functions ¶
This section is empty.
Types ¶
type ArkIdentityUsersService ¶
type ArkIdentityUsersService struct {
services.ArkService
*services.ArkBaseService
// contains filtered or unexported fields
}
ArkIdentityUsersService is the service for managing identity users.
func NewArkIdentityUsersService ¶
func NewArkIdentityUsersService(authenticators ...auth.ArkAuth) (*ArkIdentityUsersService, error)
NewArkIdentityUsersService creates a new instance of ArkIdentityUsersService.
func (*ArkIdentityUsersService) CreateUser ¶
func (s *ArkIdentityUsersService) CreateUser(createUser *usersmodels.ArkIdentityCreateUser) (*usersmodels.ArkIdentityUser, error)
CreateUser creates a new user in the identity service.
func (*ArkIdentityUsersService) DeleteUser ¶
func (s *ArkIdentityUsersService) DeleteUser(deleteUser *usersmodels.ArkIdentityDeleteUser) error
DeleteUser deletes an existing user in the identity service.
func (*ArkIdentityUsersService) DeleteUsers ¶
func (s *ArkIdentityUsersService) DeleteUsers(deleteUsers *usersmodels.ArkIdentityDeleteUsers) error
DeleteUsers deletes multiple users in the identity service.
func (*ArkIdentityUsersService) ResetUserPassword ¶
func (s *ArkIdentityUsersService) ResetUserPassword(resetUserPassword *usersmodels.ArkIdentityResetUserPassword) error
ResetUserPassword resets the password for an existing user in the identity service.
func (*ArkIdentityUsersService) ServiceConfig ¶
func (s *ArkIdentityUsersService) ServiceConfig() services.ArkServiceConfig
ServiceConfig returns the service configuration for the ArkIdentityUsersService.
func (*ArkIdentityUsersService) UpdateUser ¶
func (s *ArkIdentityUsersService) UpdateUser(updateUser *usersmodels.ArkIdentityUpdateUser) error
UpdateUser updates an existing user in the identity service.
func (*ArkIdentityUsersService) UserByID ¶
func (s *ArkIdentityUsersService) UserByID(userByID *usersmodels.ArkIdentityUserByID) (*usersmodels.ArkIdentityUser, error)
UserByID retrieves the user by user ID.
func (*ArkIdentityUsersService) UserByName ¶
func (s *ArkIdentityUsersService) UserByName(user *usersmodels.ArkIdentityUserByName) (*usersmodels.ArkIdentityUser, error)
UserByName retrieves the user by username.
func (*ArkIdentityUsersService) UserIDByName ¶
func (s *ArkIdentityUsersService) UserIDByName(user *usersmodels.ArkIdentityUserIDByName) (string, error)
UserIDByName retrieves the user ID by username.
func (*ArkIdentityUsersService) UserInfo ¶
func (s *ArkIdentityUsersService) UserInfo() (*usersmodels.ArkIdentityUserInfo, error)
UserInfo retrieves the user info from the identity service.