Documentation ¶
Index ¶
- Constants
- type Client
- func (c *Client) CreateApiImportUserJob(request *CreateApiImportUserJobRequest) (response *CreateApiImportUserJobResponse, err error)
- func (c *Client) CreateApiImportUserJobWithContext(ctx context.Context, request *CreateApiImportUserJobRequest) (response *CreateApiImportUserJobResponse, err error)
- func (c *Client) CreateFileExportUserJob(request *CreateFileExportUserJobRequest) (response *CreateFileExportUserJobResponse, err error)
- func (c *Client) CreateFileExportUserJobWithContext(ctx context.Context, request *CreateFileExportUserJobRequest) (response *CreateFileExportUserJobResponse, err error)
- func (c *Client) CreateUser(request *CreateUserRequest) (response *CreateUserResponse, err error)
- func (c *Client) CreateUserWithContext(ctx context.Context, request *CreateUserRequest) (response *CreateUserResponse, err error)
- func (c *Client) DeleteUsers(request *DeleteUsersRequest) (response *DeleteUsersResponse, err error)
- func (c *Client) DeleteUsersWithContext(ctx context.Context, request *DeleteUsersRequest) (response *DeleteUsersResponse, err error)
- func (c *Client) DescribeUser(request *DescribeUserRequest) (response *DescribeUserResponse, err error)
- func (c *Client) DescribeUserById(request *DescribeUserByIdRequest) (response *DescribeUserByIdResponse, err error)
- func (c *Client) DescribeUserByIdWithContext(ctx context.Context, request *DescribeUserByIdRequest) (response *DescribeUserByIdResponse, err error)
- func (c *Client) DescribeUserWithContext(ctx context.Context, request *DescribeUserRequest) (response *DescribeUserResponse, err error)
- func (c *Client) LinkAccount(request *LinkAccountRequest) (response *LinkAccountResponse, err error)
- func (c *Client) LinkAccountWithContext(ctx context.Context, request *LinkAccountRequest) (response *LinkAccountResponse, err error)
- func (c *Client) ListJobs(request *ListJobsRequest) (response *ListJobsResponse, err error)
- func (c *Client) ListJobsWithContext(ctx context.Context, request *ListJobsRequest) (response *ListJobsResponse, err error)
- func (c *Client) ListLogMessageByCondition(request *ListLogMessageByConditionRequest) (response *ListLogMessageByConditionResponse, err error)
- func (c *Client) ListLogMessageByConditionWithContext(ctx context.Context, request *ListLogMessageByConditionRequest) (response *ListLogMessageByConditionResponse, err error)
- func (c *Client) ListUser(request *ListUserRequest) (response *ListUserResponse, err error)
- func (c *Client) ListUserByProperty(request *ListUserByPropertyRequest) (response *ListUserByPropertyResponse, err error)
- func (c *Client) ListUserByPropertyWithContext(ctx context.Context, request *ListUserByPropertyRequest) (response *ListUserByPropertyResponse, err error)
- func (c *Client) ListUserWithContext(ctx context.Context, request *ListUserRequest) (response *ListUserResponse, err error)
- func (c *Client) ResetPassword(request *ResetPasswordRequest) (response *ResetPasswordResponse, err error)
- func (c *Client) ResetPasswordWithContext(ctx context.Context, request *ResetPasswordRequest) (response *ResetPasswordResponse, err error)
- func (c *Client) SetPassword(request *SetPasswordRequest) (response *SetPasswordResponse, err error)
- func (c *Client) SetPasswordWithContext(ctx context.Context, request *SetPasswordRequest) (response *SetPasswordResponse, err error)
- func (c *Client) UpdateUser(request *UpdateUserRequest) (response *UpdateUserResponse, err error)
- func (c *Client) UpdateUserStatus(request *UpdateUserStatusRequest) (response *UpdateUserStatusResponse, err error)
- func (c *Client) UpdateUserStatusWithContext(ctx context.Context, request *UpdateUserStatusRequest) (response *UpdateUserStatusResponse, err error)
- func (c *Client) UpdateUserWithContext(ctx context.Context, request *UpdateUserRequest) (response *UpdateUserResponse, err error)
- type CreateApiImportUserJobRequest
- type CreateApiImportUserJobRequestParams
- type CreateApiImportUserJobResponse
- type CreateApiImportUserJobResponseParams
- type CreateFileExportUserJobRequest
- type CreateFileExportUserJobRequestParams
- type CreateFileExportUserJobResponse
- type CreateFileExportUserJobResponseParams
- type CreateUserRequest
- type CreateUserRequestParams
- type CreateUserResponse
- type CreateUserResponseParams
- type DeleteUsersRequest
- type DeleteUsersRequestParams
- type DeleteUsersResponse
- type DeleteUsersResponseParams
- type DescribeUserByIdRequest
- type DescribeUserByIdRequestParams
- type DescribeUserByIdResponse
- type DescribeUserByIdResponseParams
- type DescribeUserRequest
- type DescribeUserRequestParams
- type DescribeUserResponse
- type DescribeUserResponseParams
- type ErrorDetails
- type ExportPropertyMap
- type FailedUsers
- type Filter
- type ImportUser
- type Job
- type LinkAccountRequest
- type LinkAccountRequestParams
- type LinkAccountResponse
- type LinkAccountResponseParams
- type ListJobsRequest
- type ListJobsRequestParams
- type ListJobsResponse
- type ListJobsResponseParams
- type ListLogMessageByConditionRequest
- type ListLogMessageByConditionRequestParams
- type ListLogMessageByConditionResponse
- type ListLogMessageByConditionResponseParams
- type ListUserByPropertyRequest
- type ListUserByPropertyRequestParams
- type ListUserByPropertyResponse
- type ListUserByPropertyResponseParams
- type ListUserRequest
- type ListUserRequestParams
- type ListUserResponse
- type ListUserResponseParams
- type LogMessage
- type MemberMap
- type Pageable
- type QueryUserFilter
- type ResetPasswordRequest
- type ResetPasswordRequestParams
- type ResetPasswordResponse
- type ResetPasswordResponseParams
- type Salt
- type SaltLocation
- type SaltLocationRule
- type SetPasswordRequest
- type SetPasswordRequestParams
- type SetPasswordResponse
- type SetPasswordResponseParams
- type Sort
- type UpdateUserRequest
- type UpdateUserRequestParams
- type UpdateUserResponse
- type UpdateUserResponseParams
- type UpdateUserStatusRequest
- type UpdateUserStatusRequestParams
- type UpdateUserStatusResponse
- type UpdateUserStatusResponseParams
- type User
Constants ¶
const ( // A CAM signature/authentication error occurred. AUTHFAILURE = "AuthFailure" // `DryRun` Operation. It means that the request would have succeeded, but the `DryRun` parameter was used. DRYRUNOPERATION = "DryRunOperation" // The operation failed. FAILEDOPERATION = "FailedOperation" // The secondary account has already been merged and cannot be merged again. FAILEDOPERATION_ACCOUNTALREADYBELINKED = "FailedOperation.AccountAlreadyBeLinked" // The user attribute format is abnormal. FAILEDOPERATION_ATTRIBUTEFORMATERROR = "FailedOperation.AttributeFormatError" // There are already two valid tasks. Wait for one of them to complete and try again. FAILEDOPERATION_DATAFLOWTOOMANYREQUESTS = "FailedOperation.DataFlowTooManyRequests" // The email address has already been bound to a user. FAILEDOPERATION_EMAILALREADYEXISTS = "FailedOperation.EmailAlreadyExists" // The email address cannot be empty. FAILEDOPERATION_EMAILISNULL = "FailedOperation.EmailIsNull" // The user is empty during user import. FAILEDOPERATION_IMPORTUSERISEMPTY = "FailedOperation.ImportUserIsEmpty" // indexedAttribute can contain up to 512 characters. FAILEDOPERATION_INDEXEDATTRIBUTETOOLONG = "FailedOperation.IndexedAttributeTooLong" // The tenant is invalid. FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" // The status enumerated value is wrong. See the API documentation. FAILEDOPERATION_INVALIDUSERSTATUSENUM = "FailedOperation.InvalidUserStatusEnum" // The user pool is invalid. FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" // The password cannot be empty. FAILEDOPERATION_PASSWORDISNULL = "FailedOperation.PasswordIsNull" // The mobile number has already been bound to a user. FAILEDOPERATION_PHONENUMBERALREADYEXISTS = "FailedOperation.PhoneNumberAlreadyExists" // The mobile number cannot be empty. FAILEDOPERATION_PHONENUMBERISNULL = "FailedOperation.PhoneNumberIsNull" // The primary user does not exist. FAILEDOPERATION_PRIMARYUSERNOTFOUND = "FailedOperation.PrimaryUserNotFound" // The query condition must contain at least one of the followings: userName, phoneNumber, email, userGroup, alipayUserId, wechatOpenId,wechatUnionId, qqOpenId, qqUnionId,lastModifiedDate, indexedAttribute1, indexedAttribute2,indexedAttribute3, indexedAttribute4, indexedAttribute5. FAILEDOPERATION_QUERYUSERSPARAMETERMUSTINWHITELIST = "FailedOperation.QueryUsersParameterMustInWhitelist" // The conditions can not duplicate. FAILEDOPERATION_QUERYUSERSPARAMETERREPEAT = "FailedOperation.QueryUsersParameterRepeat" // The `PropertyKey` of `Sort` must include one of the followings: id, userName, phoneNumber, email, userGroup, alipayUserId, wechatOpenId,wechatUnionId, qqOpenId, qqUnionId,lastModifiedDate, indexedAttribute1, indexedAttribute2,indexedAttribute3, indexedAttribute4, indexedAttribute5. FAILEDOPERATION_QUERYUSERSSORTPARAMETERMUSTINWHITELIST = "FailedOperation.QueryUsersSortParameterMustInWhitelist" // The quota is exceeded. Contact customer service. FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" // The secondary user does not exist. FAILEDOPERATION_SECONDARYUSERNOTFOUND = "FailedOperation.SecondaryUserNotFound" // The user group does not exist. FAILEDOPERATION_USERGROUPNOTFOUND = "FailedOperation.UserGroupNotFound" // The user account is frozen. FAILEDOPERATION_USERISFREEZE = "FailedOperation.UserIsFreeze" // The user name already exists. FAILEDOPERATION_USERNAMEALREADYEXISTS = "FailedOperation.UserNameAlreadyExists" // The username cannot be empty. FAILEDOPERATION_USERNAMEISNULL = "FailedOperation.UserNameIsNull" // The user does not exist. FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" // The updated status is required. FAILEDOPERATION_USERSTATUSREQUIRED = "FailedOperation.UserStatusRequired" // An internal error occurred. INTERNALERROR = "InternalError" // An unknown error occurred. INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" // The parameter is incorrect. INVALIDPARAMETER = "InvalidParameter" // The request parameter is invalid. INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" // The parameter value is incorrect. INVALIDPARAMETERVALUE = "InvalidParameterValue" // The quota limit is exceeded. LIMITEXCEEDED = "LimitExceeded" // The parameter is missing. MISSINGPARAMETER = "MissingParameter" // The operation was denied. OPERATIONDENIED = "OperationDenied" // The number of requests exceeds the frequency limit. REQUESTLIMITEXCEEDED = "RequestLimitExceeded" // Too many requests. Try again later. REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" // Repeated request. Try again later. REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" // The resource is in use. RESOURCEINUSE = "ResourceInUse" // The resource is insufficient. RESOURCEINSUFFICIENT = "ResourceInsufficient" // The resource does not exist. RESOURCENOTFOUND = "ResourceNotFound" // The resource is unavailable. RESOURCEUNAVAILABLE = "ResourceUnavailable" // The resources have been sold out. RESOURCESSOLDOUT = "ResourcesSoldOut" // The operation is unauthorized. UNAUTHORIZEDOPERATION = "UnauthorizedOperation" // The service is not activated. UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" // The parameter is unknown. UNKNOWNPARAMETER = "UnknownParameter" // The operation is not supported. UNSUPPORTEDOPERATION = "UnsupportedOperation" )
const APIVersion = "2022-03-31"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) CreateApiImportUserJob ¶
func (c *Client) CreateApiImportUserJob(request *CreateApiImportUserJobRequest) (response *CreateApiImportUserJobResponse, err error)
CreateApiImportUserJob This API is used to create an API for user import task.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_DATAFLOWTOOMANYREQUESTS = "FailedOperation.DataFlowTooManyRequests" FAILEDOPERATION_IMPORTUSERISEMPTY = "FailedOperation.ImportUserIsEmpty" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) CreateApiImportUserJobWithContext ¶
func (c *Client) CreateApiImportUserJobWithContext(ctx context.Context, request *CreateApiImportUserJobRequest) (response *CreateApiImportUserJobResponse, err error)
CreateApiImportUserJob This API is used to create an API for user import task.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_DATAFLOWTOOMANYREQUESTS = "FailedOperation.DataFlowTooManyRequests" FAILEDOPERATION_IMPORTUSERISEMPTY = "FailedOperation.ImportUserIsEmpty" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) CreateFileExportUserJob ¶
func (c *Client) CreateFileExportUserJob(request *CreateFileExportUserJobRequest) (response *CreateFileExportUserJobResponse, err error)
CreateFileExportUserJob This API is used to create a file for user export task.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_DATAFLOWTOOMANYREQUESTS = "FailedOperation.DataFlowTooManyRequests" FAILEDOPERATION_IMPORTUSERISEMPTY = "FailedOperation.ImportUserIsEmpty" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) CreateFileExportUserJobWithContext ¶
func (c *Client) CreateFileExportUserJobWithContext(ctx context.Context, request *CreateFileExportUserJobRequest) (response *CreateFileExportUserJobResponse, err error)
CreateFileExportUserJob This API is used to create a file for user export task.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_DATAFLOWTOOMANYREQUESTS = "FailedOperation.DataFlowTooManyRequests" FAILEDOPERATION_IMPORTUSERISEMPTY = "FailedOperation.ImportUserIsEmpty" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) CreateUser ¶
func (c *Client) CreateUser(request *CreateUserRequest) (response *CreateUserResponse, err error)
CreateUser This API is used to create a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_ATTRIBUTEFORMATERROR = "FailedOperation.AttributeFormatError" FAILEDOPERATION_EMAILALREADYEXISTS = "FailedOperation.EmailAlreadyExists" FAILEDOPERATION_EMAILISNULL = "FailedOperation.EmailIsNull" FAILEDOPERATION_INDEXEDATTRIBUTETOOLONG = "FailedOperation.IndexedAttributeTooLong" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_PASSWORDISNULL = "FailedOperation.PasswordIsNull" FAILEDOPERATION_PHONENUMBERALREADYEXISTS = "FailedOperation.PhoneNumberAlreadyExists" FAILEDOPERATION_PHONENUMBERISNULL = "FailedOperation.PhoneNumberIsNull" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERGROUPNOTFOUND = "FailedOperation.UserGroupNotFound" FAILEDOPERATION_USERNAMEALREADYEXISTS = "FailedOperation.UserNameAlreadyExists" FAILEDOPERATION_USERNAMEISNULL = "FailedOperation.UserNameIsNull" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) CreateUserWithContext ¶
func (c *Client) CreateUserWithContext(ctx context.Context, request *CreateUserRequest) (response *CreateUserResponse, err error)
CreateUser This API is used to create a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_ATTRIBUTEFORMATERROR = "FailedOperation.AttributeFormatError" FAILEDOPERATION_EMAILALREADYEXISTS = "FailedOperation.EmailAlreadyExists" FAILEDOPERATION_EMAILISNULL = "FailedOperation.EmailIsNull" FAILEDOPERATION_INDEXEDATTRIBUTETOOLONG = "FailedOperation.IndexedAttributeTooLong" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_PASSWORDISNULL = "FailedOperation.PasswordIsNull" FAILEDOPERATION_PHONENUMBERALREADYEXISTS = "FailedOperation.PhoneNumberAlreadyExists" FAILEDOPERATION_PHONENUMBERISNULL = "FailedOperation.PhoneNumberIsNull" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERGROUPNOTFOUND = "FailedOperation.UserGroupNotFound" FAILEDOPERATION_USERNAMEALREADYEXISTS = "FailedOperation.UserNameAlreadyExists" FAILEDOPERATION_USERNAMEISNULL = "FailedOperation.UserNameIsNull" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DeleteUsers ¶
func (c *Client) DeleteUsers(request *DeleteUsersRequest) (response *DeleteUsersResponse, err error)
DeleteUsers This API is used to delete users in batches.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DeleteUsersWithContext ¶
func (c *Client) DeleteUsersWithContext(ctx context.Context, request *DeleteUsersRequest) (response *DeleteUsersResponse, err error)
DeleteUsers This API is used to delete users in batches.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeUser ¶
func (c *Client) DescribeUser(request *DescribeUserRequest) (response *DescribeUserResponse, err error)
DescribeUser This API is used to query the user information with multiple conditions.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUERYUSERSPARAMETERMUSTINWHITELIST = "FailedOperation.QueryUsersParameterMustInWhitelist" FAILEDOPERATION_QUERYUSERSPARAMETERREPEAT = "FailedOperation.QueryUsersParameterRepeat" FAILEDOPERATION_QUERYUSERSSORTPARAMETERMUSTINWHITELIST = "FailedOperation.QueryUsersSortParameterMustInWhitelist" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeUserById ¶
func (c *Client) DescribeUserById(request *DescribeUserByIdRequest) (response *DescribeUserByIdResponse, err error)
DescribeUserById This API is used to query a user by ID.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeUserByIdWithContext ¶
func (c *Client) DescribeUserByIdWithContext(ctx context.Context, request *DescribeUserByIdRequest) (response *DescribeUserByIdResponse, err error)
DescribeUserById This API is used to query a user by ID.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeUserWithContext ¶
func (c *Client) DescribeUserWithContext(ctx context.Context, request *DescribeUserRequest) (response *DescribeUserResponse, err error)
DescribeUser This API is used to query the user information with multiple conditions.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUERYUSERSPARAMETERMUSTINWHITELIST = "FailedOperation.QueryUsersParameterMustInWhitelist" FAILEDOPERATION_QUERYUSERSPARAMETERREPEAT = "FailedOperation.QueryUsersParameterRepeat" FAILEDOPERATION_QUERYUSERSSORTPARAMETERMUSTINWHITELIST = "FailedOperation.QueryUsersSortParameterMustInWhitelist" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) LinkAccount ¶
func (c *Client) LinkAccount(request *LinkAccountRequest) (response *LinkAccountResponse, err error)
LinkAccount This API is used to merge accounts.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_ACCOUNTALREADYBELINKED = "FailedOperation.AccountAlreadyBeLinked" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTATUSENUM = "FailedOperation.InvalidUserStatusEnum" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_PRIMARYUSERNOTFOUND = "FailedOperation.PrimaryUserNotFound" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_SECONDARYUSERNOTFOUND = "FailedOperation.SecondaryUserNotFound" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) LinkAccountWithContext ¶
func (c *Client) LinkAccountWithContext(ctx context.Context, request *LinkAccountRequest) (response *LinkAccountResponse, err error)
LinkAccount This API is used to merge accounts.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_ACCOUNTALREADYBELINKED = "FailedOperation.AccountAlreadyBeLinked" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTATUSENUM = "FailedOperation.InvalidUserStatusEnum" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_PRIMARYUSERNOTFOUND = "FailedOperation.PrimaryUserNotFound" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_SECONDARYUSERNOTFOUND = "FailedOperation.SecondaryUserNotFound" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ListJobs ¶
func (c *Client) ListJobs(request *ListJobsRequest) (response *ListJobsResponse, err error)
ListJobs This API is used to query the details of a task.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_DATAFLOWTOOMANYREQUESTS = "FailedOperation.DataFlowTooManyRequests" FAILEDOPERATION_IMPORTUSERISEMPTY = "FailedOperation.ImportUserIsEmpty" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ListJobsWithContext ¶
func (c *Client) ListJobsWithContext(ctx context.Context, request *ListJobsRequest) (response *ListJobsResponse, err error)
ListJobs This API is used to query the details of a task.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_DATAFLOWTOOMANYREQUESTS = "FailedOperation.DataFlowTooManyRequests" FAILEDOPERATION_IMPORTUSERISEMPTY = "FailedOperation.ImportUserIsEmpty" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ListLogMessageByCondition ¶
func (c *Client) ListLogMessageByCondition(request *ListLogMessageByConditionRequest) (response *ListLogMessageByConditionResponse, err error)
ListLogMessageByCondition This API is used to query a specified log.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ListLogMessageByConditionWithContext ¶
func (c *Client) ListLogMessageByConditionWithContext(ctx context.Context, request *ListLogMessageByConditionRequest) (response *ListLogMessageByConditionResponse, err error)
ListLogMessageByCondition This API is used to query a specified log.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ListUser ¶
func (c *Client) ListUser(request *ListUserRequest) (response *ListUserResponse, err error)
ListUser This API is used to query the list of users.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ListUserByProperty ¶
func (c *Client) ListUserByProperty(request *ListUserByPropertyRequest) (response *ListUserByPropertyResponse, err error)
ListUserByProperty This API is used to query the list of users by attribute.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ListUserByPropertyWithContext ¶
func (c *Client) ListUserByPropertyWithContext(ctx context.Context, request *ListUserByPropertyRequest) (response *ListUserByPropertyResponse, err error)
ListUserByProperty This API is used to query the list of users by attribute.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ListUserWithContext ¶
func (c *Client) ListUserWithContext(ctx context.Context, request *ListUserRequest) (response *ListUserResponse, err error)
ListUser This API is used to query the list of users.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ResetPassword ¶
func (c *Client) ResetPassword(request *ResetPasswordRequest) (response *ResetPasswordResponse, err error)
ResetPassword This API is used to reset the password for a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERISFREEZE = "FailedOperation.UserIsFreeze" FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ResetPasswordWithContext ¶
func (c *Client) ResetPasswordWithContext(ctx context.Context, request *ResetPasswordRequest) (response *ResetPasswordResponse, err error)
ResetPassword This API is used to reset the password for a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERISFREEZE = "FailedOperation.UserIsFreeze" FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) SetPassword ¶
func (c *Client) SetPassword(request *SetPasswordRequest) (response *SetPasswordResponse, err error)
SetPassword This API is used to set the password for a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_PASSWORDISNULL = "FailedOperation.PasswordIsNull" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERISFREEZE = "FailedOperation.UserIsFreeze" FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) SetPasswordWithContext ¶
func (c *Client) SetPasswordWithContext(ctx context.Context, request *SetPasswordRequest) (response *SetPasswordResponse, err error)
SetPassword This API is used to set the password for a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_PASSWORDISNULL = "FailedOperation.PasswordIsNull" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERISFREEZE = "FailedOperation.UserIsFreeze" FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) UpdateUser ¶
func (c *Client) UpdateUser(request *UpdateUserRequest) (response *UpdateUserResponse, err error)
UpdateUser This API is used to update a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_ATTRIBUTEFORMATERROR = "FailedOperation.AttributeFormatError" FAILEDOPERATION_EMAILALREADYEXISTS = "FailedOperation.EmailAlreadyExists" FAILEDOPERATION_INDEXEDATTRIBUTETOOLONG = "FailedOperation.IndexedAttributeTooLong" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_PHONENUMBERALREADYEXISTS = "FailedOperation.PhoneNumberAlreadyExists" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERGROUPNOTFOUND = "FailedOperation.UserGroupNotFound" FAILEDOPERATION_USERNAMEALREADYEXISTS = "FailedOperation.UserNameAlreadyExists" FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) UpdateUserStatus ¶
func (c *Client) UpdateUserStatus(request *UpdateUserStatusRequest) (response *UpdateUserStatusResponse, err error)
UpdateUserStatus This API is used to update the status of a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTATUSENUM = "FailedOperation.InvalidUserStatusEnum" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" FAILEDOPERATION_USERSTATUSREQUIRED = "FailedOperation.UserStatusRequired" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) UpdateUserStatusWithContext ¶
func (c *Client) UpdateUserStatusWithContext(ctx context.Context, request *UpdateUserStatusRequest) (response *UpdateUserStatusResponse, err error)
UpdateUserStatus This API is used to update the status of a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTATUSENUM = "FailedOperation.InvalidUserStatusEnum" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" FAILEDOPERATION_USERSTATUSREQUIRED = "FailedOperation.UserStatusRequired" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) UpdateUserWithContext ¶
func (c *Client) UpdateUserWithContext(ctx context.Context, request *UpdateUserRequest) (response *UpdateUserResponse, err error)
UpdateUser This API is used to update a user.
error code that may be returned:
AUTHFAILURE = "AuthFailure" DRYRUNOPERATION = "DryRunOperation" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_ATTRIBUTEFORMATERROR = "FailedOperation.AttributeFormatError" FAILEDOPERATION_EMAILALREADYEXISTS = "FailedOperation.EmailAlreadyExists" FAILEDOPERATION_INDEXEDATTRIBUTETOOLONG = "FailedOperation.IndexedAttributeTooLong" FAILEDOPERATION_INVALIDTENANT = "FailedOperation.InvalidTenant" FAILEDOPERATION_INVALIDUSERSTORE = "FailedOperation.InvalidUserStore" FAILEDOPERATION_PHONENUMBERALREADYEXISTS = "FailedOperation.PhoneNumberAlreadyExists" FAILEDOPERATION_QUOTALIMITEXCEEDED = "FailedOperation.QuotaLimitExceeded" FAILEDOPERATION_USERGROUPNOTFOUND = "FailedOperation.UserGroupNotFound" FAILEDOPERATION_USERNAMEALREADYEXISTS = "FailedOperation.UserNameAlreadyExists" FAILEDOPERATION_USERNOTFOUND = "FailedOperation.UserNotFound" INTERNALERROR = "InternalError" INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PARAMETERILLEGAL = "InvalidParameter.ParameterIllegal" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" REQUESTLIMITEXCEEDED = "RequestLimitExceeded" REQUESTLIMITEXCEEDED_FREQUENTREQUEST = "RequestLimitExceeded.FrequentRequest" REQUESTLIMITEXCEEDED_REPEATREQUEST = "RequestLimitExceeded.RepeatRequest" RESOURCEINUSE = "ResourceInUse" RESOURCEINSUFFICIENT = "ResourceInsufficient" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE = "ResourceUnavailable" RESOURCESSOLDOUT = "ResourcesSoldOut" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNAUTHORIZEDOPERATION_TENANTNOTACTIVATED = "UnauthorizedOperation.TenantNotActivated" UNKNOWNPARAMETER = "UnknownParameter" UNSUPPORTEDOPERATION = "UnsupportedOperation"
type CreateApiImportUserJobRequest ¶
type CreateApiImportUserJobRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Imported user data DataFlowUserCreateList []*ImportUser `json:"DataFlowUserCreateList,omitempty" name:"DataFlowUserCreateList"` }
func NewCreateApiImportUserJobRequest ¶
func NewCreateApiImportUserJobRequest() (request *CreateApiImportUserJobRequest)
func (*CreateApiImportUserJobRequest) FromJsonString ¶
func (r *CreateApiImportUserJobRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateApiImportUserJobRequest) ToJsonString ¶
func (r *CreateApiImportUserJobRequest) ToJsonString() string
type CreateApiImportUserJobRequestParams ¶
type CreateApiImportUserJobRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Imported user data DataFlowUserCreateList []*ImportUser `json:"DataFlowUserCreateList,omitempty" name:"DataFlowUserCreateList"` }
Predefined struct for user
type CreateApiImportUserJobResponse ¶
type CreateApiImportUserJobResponse struct { *tchttp.BaseResponse Response *CreateApiImportUserJobResponseParams `json:"Response"` }
func NewCreateApiImportUserJobResponse ¶
func NewCreateApiImportUserJobResponse() (response *CreateApiImportUserJobResponse)
func (*CreateApiImportUserJobResponse) FromJsonString ¶
func (r *CreateApiImportUserJobResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateApiImportUserJobResponse) ToJsonString ¶
func (r *CreateApiImportUserJobResponse) ToJsonString() string
type CreateApiImportUserJobResponseParams ¶
type CreateApiImportUserJobResponseParams struct { // Data flow task Job *Job `json:"Job,omitempty" name:"Job"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type CreateFileExportUserJobRequest ¶
type CreateFileExportUserJobRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Exported data type // // <li> **NDJSON** </li> New-line Delimited JSON // <li> **CSV** </li> Comma-Separated Values Format *string `json:"Format,omitempty" name:"Format"` // Valid values of `Key`: `condition`, `userGroupId`. // // <li> **condition** </li> Values = Query condition, which can be user ID, username, mobile number, or email address. // <li> **userGroupId** </li> Values = User group ID Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Attributes and mapping names included in the exported user information. If this parameter is empty, all attributes will be included. ExportPropertyMaps []*ExportPropertyMap `json:"ExportPropertyMaps,omitempty" name:"ExportPropertyMaps"` }
func NewCreateFileExportUserJobRequest ¶
func NewCreateFileExportUserJobRequest() (request *CreateFileExportUserJobRequest)
func (*CreateFileExportUserJobRequest) FromJsonString ¶
func (r *CreateFileExportUserJobRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateFileExportUserJobRequest) ToJsonString ¶
func (r *CreateFileExportUserJobRequest) ToJsonString() string
type CreateFileExportUserJobRequestParams ¶
type CreateFileExportUserJobRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Exported data type // // <li> **NDJSON** </li> New-line Delimited JSON // <li> **CSV** </li> Comma-Separated Values Format *string `json:"Format,omitempty" name:"Format"` // Valid values of `Key`: `condition`, `userGroupId`. // // <li> **condition** </li> Values = Query condition, which can be user ID, username, mobile number, or email address. // <li> **userGroupId** </li> Values = User group ID Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Attributes and mapping names included in the exported user information. If this parameter is empty, all attributes will be included. ExportPropertyMaps []*ExportPropertyMap `json:"ExportPropertyMaps,omitempty" name:"ExportPropertyMaps"` }
Predefined struct for user
type CreateFileExportUserJobResponse ¶
type CreateFileExportUserJobResponse struct { *tchttp.BaseResponse Response *CreateFileExportUserJobResponseParams `json:"Response"` }
func NewCreateFileExportUserJobResponse ¶
func NewCreateFileExportUserJobResponse() (response *CreateFileExportUserJobResponse)
func (*CreateFileExportUserJobResponse) FromJsonString ¶
func (r *CreateFileExportUserJobResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateFileExportUserJobResponse) ToJsonString ¶
func (r *CreateFileExportUserJobResponse) ToJsonString() string
type CreateFileExportUserJobResponseParams ¶
type CreateFileExportUserJobResponseParams struct { // Data flow task Job *Job `json:"Job,omitempty" name:"Job"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type CreateUserRequest ¶
type CreateUserRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Mobile number PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"` // Email address Email *string `json:"Email,omitempty" name:"Email"` // Password Password *string `json:"Password,omitempty" name:"Password"` // Username UserName *string `json:"UserName,omitempty" name:"UserName"` // Nickname Nickname *string `json:"Nickname,omitempty" name:"Nickname"` // Address Address *string `json:"Address,omitempty" name:"Address"` // User group ID UserGroup []*string `json:"UserGroup,omitempty" name:"UserGroup"` // Date of birth Birthdate *int64 `json:"Birthdate,omitempty" name:"Birthdate"` // Custom attribute CustomizationAttributes []*MemberMap `json:"CustomizationAttributes,omitempty" name:"CustomizationAttributes"` // Index field 1 IndexedAttribute1 *string `json:"IndexedAttribute1,omitempty" name:"IndexedAttribute1"` // Index field 2 IndexedAttribute2 *string `json:"IndexedAttribute2,omitempty" name:"IndexedAttribute2"` // Index field 3 IndexedAttribute3 *string `json:"IndexedAttribute3,omitempty" name:"IndexedAttribute3"` // Index field 4 IndexedAttribute4 *string `json:"IndexedAttribute4,omitempty" name:"IndexedAttribute4"` // Index field 5 IndexedAttribute5 *string `json:"IndexedAttribute5,omitempty" name:"IndexedAttribute5"` }
func NewCreateUserRequest ¶
func NewCreateUserRequest() (request *CreateUserRequest)
func (*CreateUserRequest) FromJsonString ¶
func (r *CreateUserRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateUserRequest) ToJsonString ¶
func (r *CreateUserRequest) ToJsonString() string
type CreateUserRequestParams ¶
type CreateUserRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Mobile number PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"` // Email address Email *string `json:"Email,omitempty" name:"Email"` // Password Password *string `json:"Password,omitempty" name:"Password"` // Username UserName *string `json:"UserName,omitempty" name:"UserName"` // Nickname Nickname *string `json:"Nickname,omitempty" name:"Nickname"` // Address Address *string `json:"Address,omitempty" name:"Address"` // User group ID UserGroup []*string `json:"UserGroup,omitempty" name:"UserGroup"` // Date of birth Birthdate *int64 `json:"Birthdate,omitempty" name:"Birthdate"` // Custom attribute CustomizationAttributes []*MemberMap `json:"CustomizationAttributes,omitempty" name:"CustomizationAttributes"` // Index field 1 IndexedAttribute1 *string `json:"IndexedAttribute1,omitempty" name:"IndexedAttribute1"` // Index field 2 IndexedAttribute2 *string `json:"IndexedAttribute2,omitempty" name:"IndexedAttribute2"` // Index field 3 IndexedAttribute3 *string `json:"IndexedAttribute3,omitempty" name:"IndexedAttribute3"` // Index field 4 IndexedAttribute4 *string `json:"IndexedAttribute4,omitempty" name:"IndexedAttribute4"` // Index field 5 IndexedAttribute5 *string `json:"IndexedAttribute5,omitempty" name:"IndexedAttribute5"` }
Predefined struct for user
type CreateUserResponse ¶
type CreateUserResponse struct { *tchttp.BaseResponse Response *CreateUserResponseParams `json:"Response"` }
func NewCreateUserResponse ¶
func NewCreateUserResponse() (response *CreateUserResponse)
func (*CreateUserResponse) FromJsonString ¶
func (r *CreateUserResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateUserResponse) ToJsonString ¶
func (r *CreateUserResponse) ToJsonString() string
type CreateUserResponseParams ¶
type CreateUserResponseParams struct { // Information of the created user // Note: This field may return null, indicating that no valid values can be obtained. User *User `json:"User,omitempty" name:"User"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type DeleteUsersRequest ¶
type DeleteUsersRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Array of user IDs UserIds []*string `json:"UserIds,omitempty" name:"UserIds"` }
func NewDeleteUsersRequest ¶
func NewDeleteUsersRequest() (request *DeleteUsersRequest)
func (*DeleteUsersRequest) FromJsonString ¶
func (r *DeleteUsersRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteUsersRequest) ToJsonString ¶
func (r *DeleteUsersRequest) ToJsonString() string
type DeleteUsersRequestParams ¶
type DeleteUsersRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Array of user IDs UserIds []*string `json:"UserIds,omitempty" name:"UserIds"` }
Predefined struct for user
type DeleteUsersResponse ¶
type DeleteUsersResponse struct { *tchttp.BaseResponse Response *DeleteUsersResponseParams `json:"Response"` }
func NewDeleteUsersResponse ¶
func NewDeleteUsersResponse() (response *DeleteUsersResponse)
func (*DeleteUsersResponse) FromJsonString ¶
func (r *DeleteUsersResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteUsersResponse) ToJsonString ¶
func (r *DeleteUsersResponse) ToJsonString() string
type DeleteUsersResponseParams ¶
type DeleteUsersResponseParams struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeUserByIdRequest ¶
type DescribeUserByIdRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // Whether the content is passed through // // <li> **false** </li>Default. The returned information is desensitized. // <li> **true** </li>Return the original content. Original *bool `json:"Original,omitempty" name:"Original"` }
func NewDescribeUserByIdRequest ¶
func NewDescribeUserByIdRequest() (request *DescribeUserByIdRequest)
func (*DescribeUserByIdRequest) FromJsonString ¶
func (r *DescribeUserByIdRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUserByIdRequest) ToJsonString ¶
func (r *DescribeUserByIdRequest) ToJsonString() string
type DescribeUserByIdRequestParams ¶
type DescribeUserByIdRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // Whether the content is passed through // // <li> **false** </li>Default. The returned information is desensitized. // <li> **true** </li>Return the original content. Original *bool `json:"Original,omitempty" name:"Original"` }
Predefined struct for user
type DescribeUserByIdResponse ¶
type DescribeUserByIdResponse struct { *tchttp.BaseResponse Response *DescribeUserByIdResponseParams `json:"Response"` }
func NewDescribeUserByIdResponse ¶
func NewDescribeUserByIdResponse() (response *DescribeUserByIdResponse)
func (*DescribeUserByIdResponse) FromJsonString ¶
func (r *DescribeUserByIdResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUserByIdResponse) ToJsonString ¶
func (r *DescribeUserByIdResponse) ToJsonString() string
type DescribeUserByIdResponseParams ¶
type DescribeUserByIdResponseParams struct { // User information // Note: This field may return null, indicating that no valid values can be obtained. User *User `json:"User,omitempty" name:"User"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeUserRequest ¶
type DescribeUserRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Pagination data Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // Query condition (`propertycode` and `propertykey`) Filters []*QueryUserFilter `json:"Filters,omitempty" name:"Filters"` // Whether the plaintext is returned Original *bool `json:"Original,omitempty" name:"Original"` // Sorting configuration Sort *Sort `json:"Sort,omitempty" name:"Sort"` }
func NewDescribeUserRequest ¶
func NewDescribeUserRequest() (request *DescribeUserRequest)
func (*DescribeUserRequest) FromJsonString ¶
func (r *DescribeUserRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUserRequest) ToJsonString ¶
func (r *DescribeUserRequest) ToJsonString() string
type DescribeUserRequestParams ¶
type DescribeUserRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Pagination data Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // Query condition (`propertycode` and `propertykey`) Filters []*QueryUserFilter `json:"Filters,omitempty" name:"Filters"` // Whether the plaintext is returned Original *bool `json:"Original,omitempty" name:"Original"` // Sorting configuration Sort *Sort `json:"Sort,omitempty" name:"Sort"` }
Predefined struct for user
type DescribeUserResponse ¶
type DescribeUserResponse struct { *tchttp.BaseResponse Response *DescribeUserResponseParams `json:"Response"` }
func NewDescribeUserResponse ¶
func NewDescribeUserResponse() (response *DescribeUserResponse)
func (*DescribeUserResponse) FromJsonString ¶
func (r *DescribeUserResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeUserResponse) ToJsonString ¶
func (r *DescribeUserResponse) ToJsonString() string
type DescribeUserResponseParams ¶
type DescribeUserResponseParams struct { // The total number of returned results. // Note: this field may return null, indicating that no valid values can be obtained. Total *int64 `json:"Total,omitempty" name:"Total"` // Pagination object // Note: this field may return null, indicating that no valid values can be obtained. Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // User List // Note: this field may return null, indicating that no valid values can be obtained. Content []*User `json:"Content,omitempty" name:"Content"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type ErrorDetails ¶
type ExportPropertyMap ¶
type FailedUsers ¶
type FailedUsers struct { // ID of the failed user // Note: This field may return null, indicating that no valid values can be obtained. FailedUserIdentification *string `json:"FailedUserIdentification,omitempty" name:"FailedUserIdentification"` // Failure cause for user import // Note: This field may return null, indicating that no valid values can be obtained. FailedReason *string `json:"FailedReason,omitempty" name:"FailedReason"` }
type ImportUser ¶
type ImportUser struct { // Username UserName *string `json:"UserName,omitempty" name:"UserName"` // Mobile number PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"` // Email address Email *string `json:"Email,omitempty" name:"Email"` // ID card number ResidentIdentityCard *string `json:"ResidentIdentityCard,omitempty" name:"ResidentIdentityCard"` // Nickname Nickname *string `json:"Nickname,omitempty" name:"Nickname"` // Address Address *string `json:"Address,omitempty" name:"Address"` // User group ID UserGroup []*string `json:"UserGroup,omitempty" name:"UserGroup"` // `qqOpenId` on QQ QqOpenId *string `json:"QqOpenId,omitempty" name:"QqOpenId"` // `qqUnionId` on QQ QqUnionId *string `json:"QqUnionId,omitempty" name:"QqUnionId"` // `wechatOpenId` on WeChat WechatOpenId *string `json:"WechatOpenId,omitempty" name:"WechatOpenId"` // `wechatUnionId` on WeChat WechatUnionId *string `json:"WechatUnionId,omitempty" name:"WechatUnionId"` // `alipayUserId` on Alipay AlipayUserId *string `json:"AlipayUserId,omitempty" name:"AlipayUserId"` // Description Description *string `json:"Description,omitempty" name:"Description"` // Date of birth Birthdate *string `json:"Birthdate,omitempty" name:"Birthdate"` // Name Name *string `json:"Name,omitempty" name:"Name"` // Coordinate Locale *string `json:"Locale,omitempty" name:"Locale"` // Gender. Valid values: `MALE`, `FEMALE`, `UNKNOWN`. Gender *string `json:"Gender,omitempty" name:"Gender"` // Identity verification method IdentityVerificationMethod *string `json:"IdentityVerificationMethod,omitempty" name:"IdentityVerificationMethod"` // Whether the identity is verified IdentityVerified *bool `json:"IdentityVerified,omitempty" name:"IdentityVerified"` // Job Job *string `json:"Job,omitempty" name:"Job"` // Country/Region Nationality *string `json:"Nationality,omitempty" name:"Nationality"` // Time zone Zone *string `json:"Zone,omitempty" name:"Zone"` // Password ciphertext Password *string `json:"Password,omitempty" name:"Password"` // Custom attribute CustomizationAttributes []*MemberMap `json:"CustomizationAttributes,omitempty" name:"CustomizationAttributes"` // Password salt Salt *Salt `json:"Salt,omitempty" name:"Salt"` // Password encryption method. Valid values: `SHA1`, `BCRYPT`. PasswordEncryptTypeEnum *string `json:"PasswordEncryptTypeEnum,omitempty" name:"PasswordEncryptTypeEnum"` // Index field 1 IndexedAttribute1 *string `json:"IndexedAttribute1,omitempty" name:"IndexedAttribute1"` // Index field 2 IndexedAttribute2 *string `json:"IndexedAttribute2,omitempty" name:"IndexedAttribute2"` // Index field 3 IndexedAttribute3 *string `json:"IndexedAttribute3,omitempty" name:"IndexedAttribute3"` // Index field 4 IndexedAttribute4 *string `json:"IndexedAttribute4,omitempty" name:"IndexedAttribute4"` // Index field 5 IndexedAttribute5 *string `json:"IndexedAttribute5,omitempty" name:"IndexedAttribute5"` }
type Job ¶
type Job struct { // Task ID Id *string `json:"Id,omitempty" name:"Id"` // Task status // // <li> **PENDING** </li> Pending // <li> **PROCESSING** </li> Executing // <li> **COMPLETED** </li> Completed // <li> **FAILED** </li> Failed Status *string `json:"Status,omitempty" name:"Status"` // Task type // // <li> **IMPORT_USER** </li> User import // <li> **EXPORT_USER** </li> User export Type *string `json:"Type,omitempty" name:"Type"` // Task creation time CreatedDate *int64 `json:"CreatedDate,omitempty" name:"CreatedDate"` // Data type of the task // // <li> **NDJSON** </li> New-line Delimited JSON // <li> **CSV** </li> Comma-Separated Values // Note: this field may return null, indicating that no valid values can be obtained. Format *string `json:"Format,omitempty" name:"Format"` // Task result download address // Note: This field may return null, indicating that no valid values can be obtained. Location *string `json:"Location,omitempty" name:"Location"` // Failure details // Note: This field may return null, indicating that no valid values can be obtained. ErrorDetails []*ErrorDetails `json:"ErrorDetails,omitempty" name:"ErrorDetails"` // Failed user // Note: This field may return null, indicating that no valid values can be obtained. FailedUsers []*FailedUsers `json:"FailedUsers,omitempty" name:"FailedUsers"` }
type LinkAccountRequest ¶
type LinkAccountRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Primary user ID PrimaryUserId *string `json:"PrimaryUserId,omitempty" name:"PrimaryUserId"` // Secondary user ID SecondaryUserId *string `json:"SecondaryUserId,omitempty" name:"SecondaryUserId"` // Fusion attribute // // <li> **PHONENUMBER** </li> Mobile number // <li> **EMAIL** </li> Email UserLinkedOnAttribute *string `json:"UserLinkedOnAttribute,omitempty" name:"UserLinkedOnAttribute"` }
func NewLinkAccountRequest ¶
func NewLinkAccountRequest() (request *LinkAccountRequest)
func (*LinkAccountRequest) FromJsonString ¶
func (r *LinkAccountRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*LinkAccountRequest) ToJsonString ¶
func (r *LinkAccountRequest) ToJsonString() string
type LinkAccountRequestParams ¶
type LinkAccountRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Primary user ID PrimaryUserId *string `json:"PrimaryUserId,omitempty" name:"PrimaryUserId"` // Secondary user ID SecondaryUserId *string `json:"SecondaryUserId,omitempty" name:"SecondaryUserId"` // Fusion attribute // // <li> **PHONENUMBER** </li> Mobile number // <li> **EMAIL** </li> Email UserLinkedOnAttribute *string `json:"UserLinkedOnAttribute,omitempty" name:"UserLinkedOnAttribute"` }
Predefined struct for user
type LinkAccountResponse ¶
type LinkAccountResponse struct { *tchttp.BaseResponse Response *LinkAccountResponseParams `json:"Response"` }
func NewLinkAccountResponse ¶
func NewLinkAccountResponse() (response *LinkAccountResponse)
func (*LinkAccountResponse) FromJsonString ¶
func (r *LinkAccountResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*LinkAccountResponse) ToJsonString ¶
func (r *LinkAccountResponse) ToJsonString() string
type LinkAccountResponseParams ¶
type LinkAccountResponseParams struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type ListJobsRequest ¶
type ListJobsRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // List of task IDs. If this parameter is empty, all tasks will be returned. JobIds []*string `json:"JobIds,omitempty" name:"JobIds"` }
func NewListJobsRequest ¶
func NewListJobsRequest() (request *ListJobsRequest)
func (*ListJobsRequest) FromJsonString ¶
func (r *ListJobsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListJobsRequest) ToJsonString ¶
func (r *ListJobsRequest) ToJsonString() string
type ListJobsRequestParams ¶
type ListJobsRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // List of task IDs. If this parameter is empty, all tasks will be returned. JobIds []*string `json:"JobIds,omitempty" name:"JobIds"` }
Predefined struct for user
type ListJobsResponse ¶
type ListJobsResponse struct { *tchttp.BaseResponse Response *ListJobsResponseParams `json:"Response"` }
func NewListJobsResponse ¶
func NewListJobsResponse() (response *ListJobsResponse)
func (*ListJobsResponse) FromJsonString ¶
func (r *ListJobsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListJobsResponse) ToJsonString ¶
func (r *ListJobsResponse) ToJsonString() string
type ListJobsResponseParams ¶
type ListJobsResponseParams struct { // List of tasks // Note: This field may return null, indicating that no valid values can be obtained. JobSet []*Job `json:"JobSet,omitempty" name:"JobSet"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type ListLogMessageByConditionRequest ¶
type ListLogMessageByConditionRequest struct { *tchttp.BaseRequest // User pool ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Pagination data Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // Start timestamp accurate to the millisecond StartTime *int64 `json:"StartTime,omitempty" name:"StartTime"` // Valid values of `Key`: `events`. // // <li> **events** </li> Values can be one or multiple items in ["SIGNUP", "USER_UPDATE", "USER_DELETE", "USER_CREATE", "ACCOUNT_LINKING"]. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
func NewListLogMessageByConditionRequest ¶
func NewListLogMessageByConditionRequest() (request *ListLogMessageByConditionRequest)
func (*ListLogMessageByConditionRequest) FromJsonString ¶
func (r *ListLogMessageByConditionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListLogMessageByConditionRequest) ToJsonString ¶
func (r *ListLogMessageByConditionRequest) ToJsonString() string
type ListLogMessageByConditionRequestParams ¶
type ListLogMessageByConditionRequestParams struct { // User pool ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Pagination data Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // Start timestamp accurate to the millisecond StartTime *int64 `json:"StartTime,omitempty" name:"StartTime"` // Valid values of `Key`: `events`. // // <li> **events** </li> Values can be one or multiple items in ["SIGNUP", "USER_UPDATE", "USER_DELETE", "USER_CREATE", "ACCOUNT_LINKING"]. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` }
Predefined struct for user
type ListLogMessageByConditionResponse ¶
type ListLogMessageByConditionResponse struct { *tchttp.BaseResponse Response *ListLogMessageByConditionResponseParams `json:"Response"` }
func NewListLogMessageByConditionResponse ¶
func NewListLogMessageByConditionResponse() (response *ListLogMessageByConditionResponse)
func (*ListLogMessageByConditionResponse) FromJsonString ¶
func (r *ListLogMessageByConditionResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListLogMessageByConditionResponse) ToJsonString ¶
func (r *ListLogMessageByConditionResponse) ToJsonString() string
type ListLogMessageByConditionResponseParams ¶
type ListLogMessageByConditionResponseParams struct { // Total number Total *int64 `json:"Total,omitempty" name:"Total"` // Pagination object Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // List of logs // Note: This field may return null, indicating that no valid values can be obtained. Content []*LogMessage `json:"Content,omitempty" name:"Content"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type ListUserByPropertyRequest ¶
type ListUserByPropertyRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Query attribute // // <li> **phoneNumber** </li> Mobile number // <li> **email** </li> Email PropertyCode *string `json:"PropertyCode,omitempty" name:"PropertyCode"` // Attribute value PropertyValue *string `json:"PropertyValue,omitempty" name:"PropertyValue"` // Whether the content is passed through Original *bool `json:"Original,omitempty" name:"Original"` }
func NewListUserByPropertyRequest ¶
func NewListUserByPropertyRequest() (request *ListUserByPropertyRequest)
func (*ListUserByPropertyRequest) FromJsonString ¶
func (r *ListUserByPropertyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListUserByPropertyRequest) ToJsonString ¶
func (r *ListUserByPropertyRequest) ToJsonString() string
type ListUserByPropertyRequestParams ¶
type ListUserByPropertyRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Query attribute // // <li> **phoneNumber** </li> Mobile number // <li> **email** </li> Email PropertyCode *string `json:"PropertyCode,omitempty" name:"PropertyCode"` // Attribute value PropertyValue *string `json:"PropertyValue,omitempty" name:"PropertyValue"` // Whether the content is passed through Original *bool `json:"Original,omitempty" name:"Original"` }
Predefined struct for user
type ListUserByPropertyResponse ¶
type ListUserByPropertyResponse struct { *tchttp.BaseResponse Response *ListUserByPropertyResponseParams `json:"Response"` }
func NewListUserByPropertyResponse ¶
func NewListUserByPropertyResponse() (response *ListUserByPropertyResponse)
func (*ListUserByPropertyResponse) FromJsonString ¶
func (r *ListUserByPropertyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListUserByPropertyResponse) ToJsonString ¶
func (r *ListUserByPropertyResponse) ToJsonString() string
type ListUserByPropertyResponseParams ¶
type ListUserByPropertyResponseParams struct { // List of users // Note: This field may return null, indicating that no valid values can be obtained. Users []*User `json:"Users,omitempty" name:"Users"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type ListUserRequest ¶
type ListUserRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Pagination data Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // Valid values of `Key`: `condition`, `userGroupId`. // // <li> **condition** </li> Values = Query condition, which can be user ID, username, mobile number, or email address. // <li> **userGroupId** </li> Values = User group ID Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Whether the content is passed through Original *bool `json:"Original,omitempty" name:"Original"` }
func NewListUserRequest ¶
func NewListUserRequest() (request *ListUserRequest)
func (*ListUserRequest) FromJsonString ¶
func (r *ListUserRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListUserRequest) ToJsonString ¶
func (r *ListUserRequest) ToJsonString() string
type ListUserRequestParams ¶
type ListUserRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Pagination data Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // Valid values of `Key`: `condition`, `userGroupId`. // // <li> **condition** </li> Values = Query condition, which can be user ID, username, mobile number, or email address. // <li> **userGroupId** </li> Values = User group ID Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Whether the content is passed through Original *bool `json:"Original,omitempty" name:"Original"` }
Predefined struct for user
type ListUserResponse ¶
type ListUserResponse struct { *tchttp.BaseResponse Response *ListUserResponseParams `json:"Response"` }
func NewListUserResponse ¶
func NewListUserResponse() (response *ListUserResponse)
func (*ListUserResponse) FromJsonString ¶
func (r *ListUserResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListUserResponse) ToJsonString ¶
func (r *ListUserResponse) ToJsonString() string
type ListUserResponseParams ¶
type ListUserResponseParams struct { // Total number // Note: This field may return null, indicating that no valid values can be obtained. Total *int64 `json:"Total,omitempty" name:"Total"` // Pagination object // Note: This field may return null, indicating that no valid values can be obtained. Pageable *Pageable `json:"Pageable,omitempty" name:"Pageable"` // List of users // Note: This field may return null, indicating that no valid values can be obtained. Content []*User `json:"Content,omitempty" name:"Content"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type LogMessage ¶
type LogMessage struct { // Log ID LogId *string `json:"LogId,omitempty" name:"LogId"` // Tenant ID // Note: This field may return null, indicating that no valid values can be obtained. TenantId *string `json:"TenantId,omitempty" name:"TenantId"` // User pool ID // Note: This field may return null, indicating that no valid values can be obtained. UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Event code // Note: This field may return null, indicating that no valid values can be obtained. EventCode *string `json:"EventCode,omitempty" name:"EventCode"` // Event timestamp in milliseconds // Note: This field may return null, indicating that no valid values can be obtained. EventDate *int64 `json:"EventDate,omitempty" name:"EventDate"` // Description // Note: This field may return null, indicating that no valid values can be obtained. Description *string `json:"Description,omitempty" name:"Description"` // Event participant // // <li> **TENANT** </li> Tenant // <li> **USER** </li> User // Note: This field may return null, indicating that no valid values can be obtained. Participant *string `json:"Participant,omitempty" name:"Participant"` // Application `clientId` // Note: This field may return null, indicating that no valid values can be obtained. ApplicationClientId *string `json:"ApplicationClientId,omitempty" name:"ApplicationClientId"` // Application name // Note: This field may return null, indicating that no valid values can be obtained. ApplicationName *string `json:"ApplicationName,omitempty" name:"ApplicationName"` // Authentication source ID // Note: This field may return null, indicating that no valid values can be obtained. AuthSourceId *string `json:"AuthSourceId,omitempty" name:"AuthSourceId"` // Authentication source name // Note: This field may return null, indicating that no valid values can be obtained. AuthSourceName *string `json:"AuthSourceName,omitempty" name:"AuthSourceName"` // Authentication source type // Note: This field may return null, indicating that no valid values can be obtained. AuthSourceType *string `json:"AuthSourceType,omitempty" name:"AuthSourceType"` // Authentication source category // Note: This field may return null, indicating that no valid values can be obtained. AuthSourceCategory *string `json:"AuthSourceCategory,omitempty" name:"AuthSourceCategory"` // IP address // Note: This field may return null, indicating that no valid values can be obtained. Ip *string `json:"Ip,omitempty" name:"Ip"` // User agent // Note: This field may return null, indicating that no valid values can be obtained. UserAgent *string `json:"UserAgent,omitempty" name:"UserAgent"` // User ID // Note: This field may return null, indicating that no valid values can be obtained. UserId *string `json:"UserId,omitempty" name:"UserId"` // Details // Note: This field may return null, indicating that no valid values can be obtained. Detail *string `json:"Detail,omitempty" name:"Detail"` }
type QueryUserFilter ¶
type QueryUserFilter struct { // Property key PropertyKey *string `json:"PropertyKey,omitempty" name:"PropertyKey"` // Property value PropertyValue *string `json:"PropertyValue,omitempty" name:"PropertyValue"` // Logic value. `True` or `False` Logic *bool `json:"Logic,omitempty" name:"Logic"` // Operator. Values: `>`, `<`, `=`, `>=`, `<=`, `!=` and `between`. OperateLogic *string `json:"OperateLogic,omitempty" name:"OperateLogic"` }
type ResetPasswordRequest ¶
type ResetPasswordRequest struct { *tchttp.BaseRequest // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` }
func NewResetPasswordRequest ¶
func NewResetPasswordRequest() (request *ResetPasswordRequest)
func (*ResetPasswordRequest) FromJsonString ¶
func (r *ResetPasswordRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ResetPasswordRequest) ToJsonString ¶
func (r *ResetPasswordRequest) ToJsonString() string
type ResetPasswordRequestParams ¶
type ResetPasswordRequestParams struct { // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` }
Predefined struct for user
type ResetPasswordResponse ¶
type ResetPasswordResponse struct { *tchttp.BaseResponse Response *ResetPasswordResponseParams `json:"Response"` }
func NewResetPasswordResponse ¶
func NewResetPasswordResponse() (response *ResetPasswordResponse)
func (*ResetPasswordResponse) FromJsonString ¶
func (r *ResetPasswordResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ResetPasswordResponse) ToJsonString ¶
func (r *ResetPasswordResponse) ToJsonString() string
type ResetPasswordResponseParams ¶
type ResetPasswordResponseParams struct { // User password after reset Password *string `json:"Password,omitempty" name:"Password"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type Salt ¶
type Salt struct { // Salt value SaltValue *string `json:"SaltValue,omitempty" name:"SaltValue"` // Salt value location SaltLocation *SaltLocation `json:"SaltLocation,omitempty" name:"SaltLocation"` }
type SaltLocation ¶
type SaltLocation struct { // Password salt type. Valid values: `HEAD`, `TAIL`, `OTHER`. SaltLocationTypeEnum *string `json:"SaltLocationTypeEnum,omitempty" name:"SaltLocationTypeEnum"` // Salting rule SaltLocationRule *SaltLocationRule `json:"SaltLocationRule,omitempty" name:"SaltLocationRule"` }
type SaltLocationRule ¶
type SaltLocationRule struct { // Expression Regex *string `json:"Regex,omitempty" name:"Regex"` }
type SetPasswordRequest ¶
type SetPasswordRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // Password Password *string `json:"Password,omitempty" name:"Password"` }
func NewSetPasswordRequest ¶
func NewSetPasswordRequest() (request *SetPasswordRequest)
func (*SetPasswordRequest) FromJsonString ¶
func (r *SetPasswordRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SetPasswordRequest) ToJsonString ¶
func (r *SetPasswordRequest) ToJsonString() string
type SetPasswordRequestParams ¶
type SetPasswordRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // Password Password *string `json:"Password,omitempty" name:"Password"` }
Predefined struct for user
type SetPasswordResponse ¶
type SetPasswordResponse struct { *tchttp.BaseResponse Response *SetPasswordResponseParams `json:"Response"` }
func NewSetPasswordResponse ¶
func NewSetPasswordResponse() (response *SetPasswordResponse)
func (*SetPasswordResponse) FromJsonString ¶
func (r *SetPasswordResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SetPasswordResponse) ToJsonString ¶
func (r *SetPasswordResponse) ToJsonString() string
type SetPasswordResponseParams ¶
type SetPasswordResponseParams struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type UpdateUserRequest ¶
type UpdateUserRequest struct { *tchttp.BaseRequest // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Username UserName *string `json:"UserName,omitempty" name:"UserName"` // Mobile number PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"` // Email address Email *string `json:"Email,omitempty" name:"Email"` // Nickname Nickname *string `json:"Nickname,omitempty" name:"Nickname"` // Address Address *string `json:"Address,omitempty" name:"Address"` // User group UserGroup []*string `json:"UserGroup,omitempty" name:"UserGroup"` // Date of birth Birthdate *int64 `json:"Birthdate,omitempty" name:"Birthdate"` // Custom attribute CustomizationAttributes []*MemberMap `json:"CustomizationAttributes,omitempty" name:"CustomizationAttributes"` // Index field 1 IndexedAttribute1 *string `json:"IndexedAttribute1,omitempty" name:"IndexedAttribute1"` // Index field 2 IndexedAttribute2 *string `json:"IndexedAttribute2,omitempty" name:"IndexedAttribute2"` // Index field 3 IndexedAttribute3 *string `json:"IndexedAttribute3,omitempty" name:"IndexedAttribute3"` // Index field 4 IndexedAttribute4 *string `json:"IndexedAttribute4,omitempty" name:"IndexedAttribute4"` // Index field 5 IndexedAttribute5 *string `json:"IndexedAttribute5,omitempty" name:"IndexedAttribute5"` }
func NewUpdateUserRequest ¶
func NewUpdateUserRequest() (request *UpdateUserRequest)
func (*UpdateUserRequest) FromJsonString ¶
func (r *UpdateUserRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateUserRequest) ToJsonString ¶
func (r *UpdateUserRequest) ToJsonString() string
type UpdateUserRequestParams ¶
type UpdateUserRequestParams struct { // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Username UserName *string `json:"UserName,omitempty" name:"UserName"` // Mobile number PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"` // Email address Email *string `json:"Email,omitempty" name:"Email"` // Nickname Nickname *string `json:"Nickname,omitempty" name:"Nickname"` // Address Address *string `json:"Address,omitempty" name:"Address"` // User group UserGroup []*string `json:"UserGroup,omitempty" name:"UserGroup"` // Date of birth Birthdate *int64 `json:"Birthdate,omitempty" name:"Birthdate"` // Custom attribute CustomizationAttributes []*MemberMap `json:"CustomizationAttributes,omitempty" name:"CustomizationAttributes"` // Index field 1 IndexedAttribute1 *string `json:"IndexedAttribute1,omitempty" name:"IndexedAttribute1"` // Index field 2 IndexedAttribute2 *string `json:"IndexedAttribute2,omitempty" name:"IndexedAttribute2"` // Index field 3 IndexedAttribute3 *string `json:"IndexedAttribute3,omitempty" name:"IndexedAttribute3"` // Index field 4 IndexedAttribute4 *string `json:"IndexedAttribute4,omitempty" name:"IndexedAttribute4"` // Index field 5 IndexedAttribute5 *string `json:"IndexedAttribute5,omitempty" name:"IndexedAttribute5"` }
Predefined struct for user
type UpdateUserResponse ¶
type UpdateUserResponse struct { *tchttp.BaseResponse Response *UpdateUserResponseParams `json:"Response"` }
func NewUpdateUserResponse ¶
func NewUpdateUserResponse() (response *UpdateUserResponse)
func (*UpdateUserResponse) FromJsonString ¶
func (r *UpdateUserResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateUserResponse) ToJsonString ¶
func (r *UpdateUserResponse) ToJsonString() string
type UpdateUserResponseParams ¶
type UpdateUserResponseParams struct { // User information after update // Note: This field may return null, indicating that no valid values can be obtained. User *User `json:"User,omitempty" name:"User"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type UpdateUserStatusRequest ¶
type UpdateUserStatusRequest struct { *tchttp.BaseRequest // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // User status // // <li> **NORMAL** </li> Normal // <li> **LOCK** </li> Locked // <li> **FREEZE** </li> Frozen Status *string `json:"Status,omitempty" name:"Status"` }
func NewUpdateUserStatusRequest ¶
func NewUpdateUserStatusRequest() (request *UpdateUserStatusRequest)
func (*UpdateUserStatusRequest) FromJsonString ¶
func (r *UpdateUserStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateUserStatusRequest) ToJsonString ¶
func (r *UpdateUserStatusRequest) ToJsonString() string
type UpdateUserStatusRequestParams ¶
type UpdateUserStatusRequestParams struct { // User directory ID UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // User status // // <li> **NORMAL** </li> Normal // <li> **LOCK** </li> Locked // <li> **FREEZE** </li> Frozen Status *string `json:"Status,omitempty" name:"Status"` }
Predefined struct for user
type UpdateUserStatusResponse ¶
type UpdateUserStatusResponse struct { *tchttp.BaseResponse Response *UpdateUserStatusResponseParams `json:"Response"` }
func NewUpdateUserStatusResponse ¶
func NewUpdateUserStatusResponse() (response *UpdateUserStatusResponse)
func (*UpdateUserStatusResponse) FromJsonString ¶
func (r *UpdateUserStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateUserStatusResponse) ToJsonString ¶
func (r *UpdateUserStatusResponse) ToJsonString() string
type UpdateUserStatusResponseParams ¶
type UpdateUserStatusResponseParams struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` }
Predefined struct for user
type User ¶
type User struct { // User ID UserId *string `json:"UserId,omitempty" name:"UserId"` // Username // Note: This field may return null, indicating that no valid values can be obtained. UserName *string `json:"UserName,omitempty" name:"UserName"` // Mobile number // Note: This field may return null, indicating that no valid values can be obtained. PhoneNumber *string `json:"PhoneNumber,omitempty" name:"PhoneNumber"` // Email address // Note: This field may return null, indicating that no valid values can be obtained. Email *string `json:"Email,omitempty" name:"Email"` // Last login time // Note: This field may return null, indicating that no valid values can be obtained. LastSignOn *int64 `json:"LastSignOn,omitempty" name:"LastSignOn"` // Creation time CreatedDate *int64 `json:"CreatedDate,omitempty" name:"CreatedDate"` // Status Status *string `json:"Status,omitempty" name:"Status"` // User source UserDataSourceEnum *string `json:"UserDataSourceEnum,omitempty" name:"UserDataSourceEnum"` // Nickname // Note: This field may return null, indicating that no valid values can be obtained. Nickname *string `json:"Nickname,omitempty" name:"Nickname"` // Address // Note: This field may return null, indicating that no valid values can be obtained. Address *string `json:"Address,omitempty" name:"Address"` // Date of birth // Note: This field may return null, indicating that no valid values can be obtained. Birthdate *int64 `json:"Birthdate,omitempty" name:"Birthdate"` // User group ID // Note: This field may return null, indicating that no valid values can be obtained. UserGroups []*string `json:"UserGroups,omitempty" name:"UserGroups"` // Last modified time // Note: This field may return null, indicating that no valid values can be obtained. LastModifiedDate *int64 `json:"LastModifiedDate,omitempty" name:"LastModifiedDate"` // Custom attribute // Note: This field may return null, indicating that no valid values can be obtained. CustomAttributes []*MemberMap `json:"CustomAttributes,omitempty" name:"CustomAttributes"` // ID card number // Note: This field may return null, indicating that no valid values can be obtained. ResidentIdentityCard *string `json:"ResidentIdentityCard,omitempty" name:"ResidentIdentityCard"` // `OpenId` on QQ // Note: This field may return null, indicating that no valid values can be obtained. QqOpenId *string `json:"QqOpenId,omitempty" name:"QqOpenId"` // `UnionId` on QQ // Note: This field may return null, indicating that no valid values can be obtained. QqUnionId *string `json:"QqUnionId,omitempty" name:"QqUnionId"` // `WechatOpenId` on WeChat // Note: This field may return null, indicating that no valid values can be obtained. WechatOpenId *string `json:"WechatOpenId,omitempty" name:"WechatOpenId"` // `WechatUnionId` on WeChat // Note: This field may return null, indicating that no valid values can be obtained. WechatUnionId *string `json:"WechatUnionId,omitempty" name:"WechatUnionId"` // `AlipayUserId` on Alipay // Note: This field may return null, indicating that no valid values can be obtained. AlipayUserId *string `json:"AlipayUserId,omitempty" name:"AlipayUserId"` // Description // Note: This field may return null, indicating that no valid values can be obtained. Description *string `json:"Description,omitempty" name:"Description"` // Name // Note: This field may return null, indicating that no valid values can be obtained. Name *string `json:"Name,omitempty" name:"Name"` // Coordinate // Note: This field may return null, indicating that no valid values can be obtained. Locale *string `json:"Locale,omitempty" name:"Locale"` // Gender // Note: This field may return null, indicating that no valid values can be obtained. Gender *string `json:"Gender,omitempty" name:"Gender"` // Identity verification method // Note: This field may return null, indicating that no valid values can be obtained. IdentityVerificationMethod *string `json:"IdentityVerificationMethod,omitempty" name:"IdentityVerificationMethod"` // Whether the identity is verified // Note: This field may return null, indicating that no valid values can be obtained. IdentityVerified *bool `json:"IdentityVerified,omitempty" name:"IdentityVerified"` // Job // Note: This field may return null, indicating that no valid values can be obtained. Job *string `json:"Job,omitempty" name:"Job"` // Country/Region // Note: This field may return null, indicating that no valid values can be obtained. Nationality *string `json:"Nationality,omitempty" name:"Nationality"` // Whether the account is the primary account (after account merge, this parameter is `true` for primary accounts and `false` for secondary account). // Note: This field may return null, indicating that no valid values can be obtained. Primary *bool `json:"Primary,omitempty" name:"Primary"` // Time zone // Note: This field may return null, indicating that no valid values can be obtained. Zone *string `json:"Zone,omitempty" name:"Zone"` // Whether the account has ever logged in. // Note: This field may return null, indicating that no valid values can be obtained. AlreadyFirstLogin *bool `json:"AlreadyFirstLogin,omitempty" name:"AlreadyFirstLogin"` // Tenant ID // Note: This field may return null, indicating that no valid values can be obtained. TenantId *string `json:"TenantId,omitempty" name:"TenantId"` // User directory ID // Note: This field may return null, indicating that no valid values can be obtained. UserStoreId *string `json:"UserStoreId,omitempty" name:"UserStoreId"` // Version // Note: This field may return null, indicating that no valid values can be obtained. Version *int64 `json:"Version,omitempty" name:"Version"` // Lock type (locked by admin or locked by login policy) // Note: This field may return null, indicating that no valid values can be obtained. LockType *string `json:"LockType,omitempty" name:"LockType"` // Lock time // Note: This field may return null, indicating that no valid values can be obtained. LockTime *int64 `json:"LockTime,omitempty" name:"LockTime"` // Index field 1 // Note: this field may return null, indicating that no valid values can be obtained. IndexedAttribute1 *string `json:"IndexedAttribute1,omitempty" name:"IndexedAttribute1"` // Index field 2 // Note: this field may return null, indicating that no valid values can be obtained. IndexedAttribute2 *string `json:"IndexedAttribute2,omitempty" name:"IndexedAttribute2"` // Index field 3 // Note: this field may return null, indicating that no valid values can be obtained. IndexedAttribute3 *string `json:"IndexedAttribute3,omitempty" name:"IndexedAttribute3"` // Index field 4 // Note: this field may return null, indicating that no valid values can be obtained. IndexedAttribute4 *string `json:"IndexedAttribute4,omitempty" name:"IndexedAttribute4"` // Index field 5 // Note: this field may return null, indicating that no valid values can be obtained. IndexedAttribute5 *string `json:"IndexedAttribute5,omitempty" name:"IndexedAttribute5"` }