UserProfile

Package : spaceone.api.identity.v2

UserProfile

UserProfile Methods:

Method	Request	Response
update	UpdateUserProfileRequest	UserInfo
verify_email	VerifyEmailRequest	Empty
confirm_email	ConfirmEmailRequest	UserInfo
reset_password	UserPasswordResetRequest	Empty
enable_mfa	EnableMFARequest	UserInfo
disable_mfa	DisableMFARequest	UserInfo
confirm_mfa	ConfirmMFARequest	UserInfo
get	UserProfileRequest	UserInfo
get_workspaces	UserProfileRequest	MyWorkspacesInfo
get_workspace_groups	WorkspaceGroupUserProfileRequest	MyWorkspaceGroupsInfo

update

POST /identity/v2/user-profile/update

verify_email

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

{{< tabs " verify_email " >}}

{{< tab "Request Example" >}}

VerifyEmailRequest

• email (string)

{{< highlight json >}} { "email": "[e-mail]" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

confirm_email

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

{{< tabs " confirm_email " >}}

{{< tab "Request Example" >}}

ConfirmEmailRequest

• verify_code (string) Required

{{< highlight json >}} { "verify_code": "12346" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

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

{{< tabs " enable_mfa " >}}

{{< tab "Request Example" >}}

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.

{{< highlight json >}} { "user_id": "[e-mail]", "mfa_type": "EMAIL", "options": {"email": "[e-mail]"}, "domain_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

disable_mfa

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

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

{{< tabs " disable_mfa " >}}

{{< tab "Request Example" >}}

DisableMFARequest

{{< highlight json >}} { "user_id": "[e-mail]", "force": false, "domain_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

confirm_mfa

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

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

{{< tabs " confirm_mfa " >}}

{{< tab "Request Example" >}}

ConfirmMFARequest

• verify_code (string) Required

{{< highlight json >}} { "user_id": "example@cloudforet", "verify_code": "123456", "domain_id": "domain-a1b2c3d4e5f6" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

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