uaccount

package
v0.21.39 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2022 License: Apache-2.0 Imports: 4 Imported by: 10

Documentation

Overview

Package uaccount include resources of ucloud uaccount product

See also

for detail.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddMemberToProjectRequest added in v0.21.4 

type AddMemberToProjectRequest struct {
	request.CommonBase

	// 被加入成员归属角色ID
	CharacterId *string `required:"true"`

	// 被加入成员Email
	MemberEmail *string `required:"true"`
}

AddMemberToProjectRequest is request schema for AddMemberToProject action

type AddMemberToProjectResponse added in v0.21.4 

type AddMemberToProjectResponse struct {
	response.CommonBase
}

AddMemberToProjectResponse is response schema for AddMemberToProject action

type CharacterSet added in v0.21.4 

type CharacterSet struct {

	// 角色描述
	CharacterDescription string

	// 角色ID
	CharacterId string

	// 角色名
	CharacterName string

	// 可修改性
	Modifiable bool

	// 权限列表
	PermissionSet []PermissionSet
}

CharacterSet - 角色信息

type CreateCharacterRequest added in v0.21.4 

type CreateCharacterRequest struct {
	request.CommonBase

	// 角色对产品的权限(增)
	Add []string `required:"false"`

	// 角色描述
	CharacterDescription *string `required:"false"`

	// 角色名称，不得与现有角色重名
	CharacterName *string `required:"true"`

	// 角色对产品的权限(删)
	Del []string `required:"false"`

	// 角色对产品的权限(查)
	Get []string `required:"false"`

	// 角色对产品的权限(改)
	Mod []string `required:"false"`
}

CreateCharacterRequest is request schema for CreateCharacter action

type CreateCharacterResponse added in v0.21.4 

type CreateCharacterResponse struct {
	response.CommonBase

	// 角色ID
	CharacterId string
}

CreateCharacterResponse is response schema for CreateCharacter action

type CreateProjectRequest 

type CreateProjectRequest struct {
	request.CommonBase

	//
	ParentId *string `required:"false"`

	//
	ProjectName *string `required:"true"`
}

CreateProjectRequest is request schema for CreateProject action

type CreateProjectResponse 

type CreateProjectResponse struct {
	response.CommonBase

	//
	ProjectId string
}

CreateProjectResponse is response schema for CreateProject action

type DescribeCharacterListRequest added in v0.21.4 

type DescribeCharacterListRequest struct {
	request.CommonBase

	// 角色列表的最大数量，默认为20
	Limit *int `required:"false"`

	// 角色列表的偏移量，默认为0
	Offset *int `required:"false"`
}

DescribeCharacterListRequest is request schema for DescribeCharacterList action

type DescribeCharacterListResponse added in v0.21.4 

type DescribeCharacterListResponse struct {
	response.CommonBase

	// JSON格式的角色列表实例，每项参数参见下面的 ResponseItem
	CharacterSet []CharacterSet

	// 角色总数
	TotalCount int
}

DescribeCharacterListResponse is response schema for DescribeCharacterList action

type DescribeMemberListRequest added in v0.21.4 

type DescribeMemberListRequest struct {
	request.CommonBase

	// 成员列表的最大数量，默认为200
	Limit *string `required:"false"`

	// 成员列表的偏移量，默认为0
	Offset *string `required:"false"`
}

DescribeMemberListRequest is request schema for DescribeMemberList action

type DescribeMemberListResponse added in v0.21.4 

type DescribeMemberListResponse struct {
	response.CommonBase

	// JSON格式的成员列表实例
	MemberSet []MemberInfo

	// 成员总数
	TotalCount int
}

DescribeMemberListResponse is response schema for DescribeMemberList action

type FreezeMemberRequest added in v0.21.4 

type FreezeMemberRequest struct {
	request.CommonBase

	// 需要被冻结的成员Email
	MemberEmail *string `required:"true"`
}

FreezeMemberRequest is request schema for FreezeMember action

type FreezeMemberResponse added in v0.21.4 

type FreezeMemberResponse struct {
	response.CommonBase
}

FreezeMemberResponse is response schema for FreezeMember action

type GetNetworkMaskRequest added in v0.21.4 

type GetNetworkMaskRequest struct {
	request.CommonBase
}

GetNetworkMaskRequest is request schema for GetNetworkMask action

type GetNetworkMaskResponse added in v0.21.4 

type GetNetworkMaskResponse struct {
	response.CommonBase

	// 接口返回数据
	Data NetworkMask

	// 接口信息，成功时为`success`，错误时显示具体错误信息。
	Message string
}

GetNetworkMaskResponse is response schema for GetNetworkMask action

type GetProjectListRequest 

type GetProjectListRequest struct {
	request.CommonBase

	// 是否是财务账号（Yes：是，No：否）
	IsFinance *string `required:"false"`
}

GetProjectListRequest is request schema for GetProjectList action

type GetProjectListResponse 

type GetProjectListResponse struct {
	response.CommonBase

	// 项目总数
	ProjectCount int

	// JSON格式的项目列表实例
	ProjectSet []ProjectListInfo
}

GetProjectListResponse is response schema for GetProjectList action

type GetRegionRequest 

type GetRegionRequest struct {
	request.CommonBase
}

GetRegionRequest is request schema for GetRegion action

type GetRegionResponse 

type GetRegionResponse struct {
	response.CommonBase

	// 各数据中心信息
	Regions []RegionInfo
}

GetRegionResponse is response schema for GetRegion action

type GetUserInfoRequest 

type GetUserInfoRequest struct {
	request.CommonBase
}

GetUserInfoRequest is request schema for GetUserInfo action

type GetUserInfoResponse 

type GetUserInfoResponse struct {
	response.CommonBase

	//
	DataSet []UserInfo
}

GetUserInfoResponse is response schema for GetUserInfo action

type InviteSubaccountRequest added in v0.21.4 

type InviteSubaccountRequest struct {
	request.CommonBase

	// 是否有财务权限(true:是,false:否,默认为否)
	IsFinance *string `required:"true"`

	// 受邀成员邮箱地址，不得重复
	UserEmail *string `required:"true"`

	// 受邀成员姓名
	UserName *string `required:"true"`

	// 受邀成员手机号码
	UserPhone *string `required:"true"`
}

InviteSubaccountRequest is request schema for InviteSubaccount action

type InviteSubaccountResponse added in v0.21.4 

type InviteSubaccountResponse struct {
	response.CommonBase
}

InviteSubaccountResponse is response schema for InviteSubaccount action

type MemberInfo added in v0.21.4 

type MemberInfo struct {

	// 激活状态（0：未激活，1：已激活）
	ActivateFlag int

	// 创建时间
	Created int

	// 默认项目
	DefultProjectId string

	// 是否主账号（0：子账号，1：主账号）
	IsAdmin int

	// 是否有财务权限（0：无财务权限，1：有财务权限）
	IsFinance int

	// 最后一次登录时间
	LastLogin int

	// 最后访问的机房
	LastRegionId string

	// 成员邮箱
	MemberEmail string

	// 成员名字
	MemberName string

	// 成员手机
	MemberPhone string

	// 成员地址
	MemberPosition string

	// 成员QQ
	MemberQQ string

	// 密码安全策略开启时间，格式：unix timestamp
	PasswordPolicyDate int

	// 项目列表
	ProjectSet []ProjectInfo

	// 公钥
	PublicKey string

	// 状态
	State string

	// TOTP状态（0：未开启，1：已开启）
	TOTPStatus int
}

MemberInfo - 成员信息

type ModifyCharacterRequest added in v0.21.4 

type ModifyCharacterRequest struct {
	request.CommonBase

	// 角色权限(增)
	Add []string `required:"false"`

	// 角色描述
	CharacterDescription *string `required:"false"`

	// 角色ID
	CharacterId *string `required:"true"`

	// 新角色名称
	CharacterName *string `required:"false"`

	// 角色权限(删)
	Del []string `required:"false"`

	// 角色权限(查)
	Get []string `required:"false"`

	// 角色权限(改)
	Mod []string `required:"false"`
}

ModifyCharacterRequest is request schema for ModifyCharacter action

type ModifyCharacterResponse added in v0.21.4 

type ModifyCharacterResponse struct {
	response.CommonBase
}

ModifyCharacterResponse is response schema for ModifyCharacter action

type ModifyProjectRequest 

type ModifyProjectRequest struct {
	request.CommonBase

	//
	ProjectName *string `required:"true"`
}

ModifyProjectRequest is request schema for ModifyProject action

type ModifyProjectResponse 

type ModifyProjectResponse struct {
	response.CommonBase
}

ModifyProjectResponse is response schema for ModifyProject action

type NetworkMask added in v0.21.4 

type NetworkMask struct {

	// API调用网络掩码，默认空字符串，不限制登录IP，多个IP以英文逗号分隔。
	APINetworkMask string

	// 登录网络掩码，默认空字符串，不限制登录IP，多个IP以英文逗号分隔。
	LoginNetworkMask string
}

NetworkMask - 登录与API调用的网络掩码

type PermissionSet added in v0.21.4 

type PermissionSet struct {

	// 有增权限的产品列表
	Add []string

	// 有删权限的产品列表
	Del []string

	// 有查权限的产品列表
	Get []string

	// 有改权限的产品列表
	Mod []string
}

PermissionSet - 权限列表

type ProjectInfo added in v0.21.4 

type ProjectInfo struct {

	// 角色ID
	CharacterId string

	// 项目ID，请参考[GetProjectList接口](../summary/get_project_list.html)
	ProjectId string

	// 项目名
	ProjectName string
}

ProjectInfo - 项目信息

type ProjectListInfo 

type ProjectListInfo struct {

	// 创建时间(Unix时间戳)
	CreateTime int

	// 是否为默认项目
	IsDefault bool

	// 项目下成员数量
	MemberCount int

	// 父项目ID（已废弃）
	ParentId string

	// 父项目名称（已废弃）
	ParentName string

	// 项目ID
	ProjectId string

	// 项目名称
	ProjectName string

	// 项目下资源数量（已废弃，不建议使用）
	ResourceCount int
}

ProjectListInfo - 项目信息

type RegionInfo 

type RegionInfo struct {

	// 用户在此数据中心的权限位
	BitMaps string

	// 是否用户当前默认数据中心
	IsDefault bool

	// 地域名字，如cn-bj
	Region string

	// 数据中心ID
	RegionId int

	// 数据中心名称
	RegionName string

	// 可用区名字，如cn-bj-01
	Zone string
}

RegionInfo - 数据中心信息

type RemoveMemberFromProjectRequest added in v0.21.4 

type RemoveMemberFromProjectRequest struct {
	request.CommonBase

	// 需要被移除成员Email
	MemberEmail *string `required:"true"`
}

RemoveMemberFromProjectRequest is request schema for RemoveMemberFromProject action

type RemoveMemberFromProjectResponse added in v0.21.4 

type RemoveMemberFromProjectResponse struct {
	response.CommonBase
}

RemoveMemberFromProjectResponse is response schema for RemoveMemberFromProject action

type SetNetworkMaskRequest added in v0.21.4 

type SetNetworkMaskRequest struct {
	request.CommonBase

	// API调用网络掩码，多个IP以英文逗号分隔。默认空字符串，不限制登录IP。
	APINetworkMask *string `required:"false"`

	// 短信验证码
	Code *string `required:"true"`

	// 登录网络掩码，多个IP以英文逗号分隔。默认空字符串，不限制登录IP。
	LoginNetworkMask *string `required:"false"`
}

SetNetworkMaskRequest is request schema for SetNetworkMask action

type SetNetworkMaskResponse added in v0.21.4 

type SetNetworkMaskResponse struct {
	response.CommonBase

	// 接口信息，成功时为`success`，错误时显示具体错误信息。
	Message string
}

SetNetworkMaskResponse is response schema for SetNetworkMask action

type TerminateCharacterRequest added in v0.21.4 

type TerminateCharacterRequest struct {
	request.CommonBase

	// 角色ID，使用[DescribeCharacterList接口](../summary/describe_character_list.html) 获取角色ID
	CharacterId *string `required:"true"`
}

TerminateCharacterRequest is request schema for TerminateCharacter action

type TerminateCharacterResponse added in v0.21.4 

type TerminateCharacterResponse struct {
	response.CommonBase
}

TerminateCharacterResponse is response schema for TerminateCharacter action

type TerminateMemberRequest added in v0.21.4 

type TerminateMemberRequest struct {
	request.CommonBase

	// 用户邮箱
	MemberEmail *string `required:"true"`
}

TerminateMemberRequest is request schema for TerminateMember action

type TerminateMemberResponse added in v0.21.4 

type TerminateMemberResponse struct {
	response.CommonBase
}

TerminateMemberResponse is response schema for TerminateMember action

type TerminateProjectRequest 

type TerminateProjectRequest struct {
	request.CommonBase
}

TerminateProjectRequest is request schema for TerminateProject action

type TerminateProjectResponse 

type TerminateProjectResponse struct {
	response.CommonBase
}

TerminateProjectResponse is response schema for TerminateProject action

type UAccountClient 

type UAccountClient struct {
	*ucloud.Client
}

UAccountClient is the client of UAccount

func NewClient 

func NewClient(config *ucloud.Config, credential *auth.Credential) *UAccountClient

NewClient will return a instance of UAccountClient

func (*UAccountClient) AddMemberToProject added in v0.21.4 

func (c *UAccountClient) AddMemberToProject(req *AddMemberToProjectRequest) (*AddMemberToProjectResponse, error)

API: AddMemberToProject

添加成员到项目

func (*UAccountClient) CreateCharacter added in v0.21.4 

func (c *UAccountClient) CreateCharacter(req *CreateCharacterRequest) (*CreateCharacterResponse, error)

API: CreateCharacter

创建角色

func (*UAccountClient) CreateProject 

func (c *UAccountClient) CreateProject(req *CreateProjectRequest) (*CreateProjectResponse, error)

API: CreateProject

func (*UAccountClient) DescribeCharacterList added in v0.21.4 

func (c *UAccountClient) DescribeCharacterList(req *DescribeCharacterListRequest) (*DescribeCharacterListResponse, error)

API: DescribeCharacterList

获取角色列表

func (*UAccountClient) DescribeMemberList added in v0.21.4 

func (c *UAccountClient) DescribeMemberList(req *DescribeMemberListRequest) (*DescribeMemberListResponse, error)

API: DescribeMemberList

获取成员列表，限主账号使用。

func (*UAccountClient) FreezeMember added in v0.21.4 

func (c *UAccountClient) FreezeMember(req *FreezeMemberRequest) (*FreezeMemberResponse, error)

API: FreezeMember

冻结成员

func (*UAccountClient) GetNetworkMask added in v0.21.4 

func (c *UAccountClient) GetNetworkMask(req *GetNetworkMaskRequest) (*GetNetworkMaskResponse, error)

API: GetNetworkMask

查询登录与API调用的网络掩码

func (*UAccountClient) GetProjectList 

func (c *UAccountClient) GetProjectList(req *GetProjectListRequest) (*GetProjectListResponse, error)

API: GetProjectList

获取项目列表

func (*UAccountClient) GetRegion 

func (c *UAccountClient) GetRegion(req *GetRegionRequest) (*GetRegionResponse, error)

API: GetRegion

获取用户在各数据中心的权限等信息

func (*UAccountClient) GetUserInfo 

func (c *UAccountClient) GetUserInfo(req *GetUserInfoRequest) (*GetUserInfoResponse, error)

API: GetUserInfo

func (*UAccountClient) InviteSubaccount added in v0.21.4 

func (c *UAccountClient) InviteSubaccount(req *InviteSubaccountRequest) (*InviteSubaccountResponse, error)

API: InviteSubaccount

邀请子帐号成员

func (*UAccountClient) ModifyCharacter added in v0.21.4 

func (c *UAccountClient) ModifyCharacter(req *ModifyCharacterRequest) (*ModifyCharacterResponse, error)

API: ModifyCharacter

修改角色

func (*UAccountClient) ModifyProject 

func (c *UAccountClient) ModifyProject(req *ModifyProjectRequest) (*ModifyProjectResponse, error)

API: ModifyProject

func (*UAccountClient) NewAddMemberToProjectRequest added in v0.21.4 

func (c *UAccountClient) NewAddMemberToProjectRequest() *AddMemberToProjectRequest

NewAddMemberToProjectRequest will create request of AddMemberToProject action.

func (*UAccountClient) NewCreateCharacterRequest added in v0.21.4 

func (c *UAccountClient) NewCreateCharacterRequest() *CreateCharacterRequest

NewCreateCharacterRequest will create request of CreateCharacter action.

func (*UAccountClient) NewCreateProjectRequest 

func (c *UAccountClient) NewCreateProjectRequest() *CreateProjectRequest

NewCreateProjectRequest will create request of CreateProject action.

func (*UAccountClient) NewDescribeCharacterListRequest added in v0.21.4 

func (c *UAccountClient) NewDescribeCharacterListRequest() *DescribeCharacterListRequest

NewDescribeCharacterListRequest will create request of DescribeCharacterList action.

func (*UAccountClient) NewDescribeMemberListRequest added in v0.21.4 

func (c *UAccountClient) NewDescribeMemberListRequest() *DescribeMemberListRequest

NewDescribeMemberListRequest will create request of DescribeMemberList action.

func (*UAccountClient) NewFreezeMemberRequest added in v0.21.4 

func (c *UAccountClient) NewFreezeMemberRequest() *FreezeMemberRequest

NewFreezeMemberRequest will create request of FreezeMember action.

func (*UAccountClient) NewGetNetworkMaskRequest added in v0.21.4 

func (c *UAccountClient) NewGetNetworkMaskRequest() *GetNetworkMaskRequest

NewGetNetworkMaskRequest will create request of GetNetworkMask action.

func (*UAccountClient) NewGetProjectListRequest 

func (c *UAccountClient) NewGetProjectListRequest() *GetProjectListRequest

NewGetProjectListRequest will create request of GetProjectList action.

func (*UAccountClient) NewGetRegionRequest 

func (c *UAccountClient) NewGetRegionRequest() *GetRegionRequest

NewGetRegionRequest will create request of GetRegion action.

func (*UAccountClient) NewGetUserInfoRequest 

func (c *UAccountClient) NewGetUserInfoRequest() *GetUserInfoRequest

NewGetUserInfoRequest will create request of GetUserInfo action.

func (*UAccountClient) NewInviteSubaccountRequest added in v0.21.4 

func (c *UAccountClient) NewInviteSubaccountRequest() *InviteSubaccountRequest

NewInviteSubaccountRequest will create request of InviteSubaccount action.

func (*UAccountClient) NewModifyCharacterRequest added in v0.21.4 

func (c *UAccountClient) NewModifyCharacterRequest() *ModifyCharacterRequest

NewModifyCharacterRequest will create request of ModifyCharacter action.

func (*UAccountClient) NewModifyProjectRequest 

func (c *UAccountClient) NewModifyProjectRequest() *ModifyProjectRequest

NewModifyProjectRequest will create request of ModifyProject action.

func (*UAccountClient) NewRemoveMemberFromProjectRequest added in v0.21.4 

func (c *UAccountClient) NewRemoveMemberFromProjectRequest() *RemoveMemberFromProjectRequest

NewRemoveMemberFromProjectRequest will create request of RemoveMemberFromProject action.

func (*UAccountClient) NewSetNetworkMaskRequest added in v0.21.4 

func (c *UAccountClient) NewSetNetworkMaskRequest() *SetNetworkMaskRequest

NewSetNetworkMaskRequest will create request of SetNetworkMask action.

func (*UAccountClient) NewTerminateCharacterRequest added in v0.21.4 

func (c *UAccountClient) NewTerminateCharacterRequest() *TerminateCharacterRequest

NewTerminateCharacterRequest will create request of TerminateCharacter action.

func (*UAccountClient) NewTerminateMemberRequest added in v0.21.4 

func (c *UAccountClient) NewTerminateMemberRequest() *TerminateMemberRequest

NewTerminateMemberRequest will create request of TerminateMember action.

func (*UAccountClient) NewTerminateProjectRequest 

func (c *UAccountClient) NewTerminateProjectRequest() *TerminateProjectRequest

NewTerminateProjectRequest will create request of TerminateProject action.

func (*UAccountClient) RemoveMemberFromProject added in v0.21.4 

func (c *UAccountClient) RemoveMemberFromProject(req *RemoveMemberFromProjectRequest) (*RemoveMemberFromProjectResponse, error)

API: RemoveMemberFromProject

从项目中移除成员

func (*UAccountClient) SetNetworkMask added in v0.21.4 

func (c *UAccountClient) SetNetworkMask(req *SetNetworkMaskRequest) (*SetNetworkMaskResponse, error)

API: SetNetworkMask

设置登录与API调用的网络掩码

func (*UAccountClient) TerminateCharacter added in v0.21.4 

func (c *UAccountClient) TerminateCharacter(req *TerminateCharacterRequest) (*TerminateCharacterResponse, error)

API: TerminateCharacter

删除用户角色管理列表中的指定角色

func (*UAccountClient) TerminateMember added in v0.21.4 

func (c *UAccountClient) TerminateMember(req *TerminateMemberRequest) (*TerminateMemberResponse, error)

API: TerminateMember

删除管理员人员管理页面的指定子账号

func (*UAccountClient) TerminateProject 

func (c *UAccountClient) TerminateProject(req *TerminateProjectRequest) (*TerminateProjectResponse, error)

API: TerminateProject

删除项目

type UserInfo 

type UserInfo struct {

	//
	Admin int

	//
	Administrator string

	//
	AuthState string

	//
	City string

	//
	CompanyName string

	//
	Finance int

	//
	IndustryType int

	//
	PhonePrefix string

	//
	Province string

	//
	UserAddress string

	//
	UserEmail string

	//
	UserId int

	//
	UserName string

	//
	UserPhone string

	//
	UserType int

	//
	UserVersion int
}

UserInfo -

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.