UserProfile

UserProfile #

Package : spaceone.api.identity.v2



UserProfile #

UserProfile Methods:

MethodRequestResponse
updateUpdateUserProfileRequestUserInfo
verify_emailVerifyEmailRequestEmpty
confirm_emailConfirmEmailRequestUserInfo
reset_passwordUserPasswordResetRequestEmpty
enable_mfaEnableMFARequestUserInfo
disable_mfaDisableMFARequestUserInfo
confirm_mfaConfirmMFARequestUserInfo
getUserProfileRequestUserInfo
get_workspacesUserProfileRequestMyWorkspacesInfo
get_workspace_groupsWorkspaceGroupUserProfileRequestMyWorkspaceGroupsInfo

update #

POST /identity/v2/user-profile/update


verify_email #

POST /identity/v2/user-profile/verify-email

VerifyEmailRequest

  • email (string)
{
  "email": "wonny@cloudforet.io"
}

confirm_email #

POST /identity/v2/user-profile/confirm-email

ConfirmEmailRequest

  • verify_code (string) Required
{
  "verify_code": "12346"
}

reset_password #

+noauth

POST /identity/v2/user-profile/reset-password


enable_mfa #

Enable MFA for user. If this api is called, send email to user.

POST /identity/v2/user-profile/enable-mfa

EnableMFARequest

  • mfa_type (string) Required

    EMAIL

  • options (Struct) Required

    If mfa_type is EMAIL, email is required in options. options will be saved in mfa’s options field.

{
 "user_id": "example@cloudforet.com",
 "mfa_type": "EMAIL",
 "options": {"email": "wonny@cloudforet.com"},
 "domain_id": "domain-a1b2c3d4e5f6"
}

disable_mfa #

Disable MFA for user. If this api is called, send email to user.

POST /identity/v2/user-profile/disable-mfa

DisableMFARequest

{
 "user_id": "example@cloudforet.com",
 "force": false,
 "domain_id": "domain-a1b2c3d4e5f6"
}

confirm_mfa #

Confirm MFA for user by given verify_code which is sent by your authentication method.

POST /identity/v2/user-profile/confirm-mfa

ConfirmMFARequest

  • verify_code (string) Required
{
 "user_id": "example@cloudforet",
 "verify_code": "123456",
 "domain_id": "domain-a1b2c3d4e5f6"
}

get #

POST /identity/v2/user-profile/get


get_workspaces #

POST /identity/v2/user-profile/get-workspaces


get_workspace_groups #

POST /identity/v2/user-profile/get-workspace-groups



Message #

ConfirmEmailRequest #

  • verify_code (string) Required


ConfirmMFARequest #

  • verify_code (string) Required


DisableMFARequest
#

EnableMFARequest #

  • mfa_type (string) Required

    EMAIL

  • options (Struct) Required

    If mfa_type is EMAIL, email is required in options. options will be saved in mfa’s options field.


MyWorkspaceGroupInfo #

  • workspace_group_id (string) Required

  • name (string) Required

  • users (UserWorkspaceGroup) Repeated Required

  • tags (Struct) Required

  • role_binding_info (RoleBindingInfo) Required

  • created_by (string) Required

  • updated_by (string) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required


MyWorkspaceGroupsInfo #

  • results (MyWorkspaceGroupInfo) Repeated Required

  • total_count (int32) Required


MyWorkspaceInfo #

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • role_name (string) Required

  • role_type (RoleType) Required

  • tags (Struct) Required

  • created_by (string) Required

  • reference_id (string) Required

  • is_managed (bool) Required

  • is_dormant (bool) Required

  • domain_id (string) Required

  • role_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required


MyWorkspacesInfo #

  • results (MyWorkspaceInfo) Repeated Required

  • total_count (int32) Required


UpdateUserProfileRequest #

  • password (string)

  • name (string)

  • email (string)

  • language (string)

  • timezone (string)

  • tags (Struct)


UserPasswordResetRequest #

  • user_id (string) Required

  • domain_id (string) Required


UserProfileRequest #

  • workspace_group_id (string)


VerifyEmailRequest #

  • email (string)


WorkspaceGroupUserProfileRequest
#

Calendar December 4, 2024
Edit Edit this page