User

User API which allows member management within project, company, and domain note: Administrator must register User first.

Package : spaceone.api.identity.v2

User

User Methods:

Method	Request	Response
create	CreateUserRequest	UserInfo
update	UpdateUserRequest	UserInfo
verify_email	VerifyUserEmailRequest	Empty
disable_mfa	DisableUserMFARequest	UserInfo
set_required_actions	SetRequiredActionsRequest	UserInfo
enable	UserRequest	UserInfo
disable	UserRequest	UserInfo
delete	UserRequest	Empty
get	UserRequest	UserInfo
list	UserSearchQuery	UsersInfo
stat	UserStatQuery	Struct

create

You can create user. after create user you have to binding role to user. See role-binding create api. External type user do not need password.

POST /identity/v2/user/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

CreateUserRequest

• user_id (string) Required

• auth_type (AuthType) Required

• reset_password (bool) Required

  If reset_password is true, send email

• password (string)

  When auth_type is LOCAL, password is required.

• name (string)

• email (string)

• language (string)

  en,ko

• timezone (string)

  UTC, Asia/Seoul

• tags (Struct)

{{< highlight json >}} { "user_id": "[e-mail]", "password": "Password1234!", "name": "Wonny", "email": "[e-mail]", "auth_type": "LOCAL", "language": "en", "timezone": "UTC" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

update

Update user info by given user_id

POST /identity/v2/user/update

verify_email

POST /identity/v2/user/verify-email

{{< tabs " verify_email " >}}

{{< tab "Request Example" >}}

VerifyUserEmailRequest

• user_id (string) Required

• email (string)

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

{{< /tabs >}}

disable_mfa

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

POST /identity/v2/user/disable-mfa

{{< tabs " disable_mfa " >}}

{{< tab "Request Example" >}}

DisableUserMFARequest

• user_id (string) Required

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

{{< /tabs >}}

set_required_actions

POST /identity/v2/user/set-required-actions

{{< tabs " set_required_actions " >}}

{{< tab "Request Example" >}}

SetRequiredActionsRequest

• user_id (string) Required

• required_actions (UserRequiredAction) Repeated Required

{{< highlight json >}} { "user_id": "[e-mail]", "required_actions": ["UPDATE_PASSWORD"] } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

enable

POST /identity/v2/user/enable

{{< tabs " enable " >}}

{{< tab "Request Example" >}}

UserRequest

• user_id (string) Required

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

{{< /tabs >}}

disable

POST /identity/v2/user/disable

{{< tabs " disable " >}}

{{< tab "Request Example" >}}

UserRequest

• user_id (string) Required

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

{{< /tabs >}}

delete

POST /identity/v2/user/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

UserRequest

• user_id (string) Required

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

{{< /tabs >}}

get

POST /identity/v2/user/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

UserRequest

• user_id (string) Required

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

{{< /tabs >}}

list

POST /identity/v2/user/list

stat

POST /identity/v1/user/stat

Message

CreateUserRequest

• user_id (string) Required

• auth_type (AuthType) Required

• reset_password (bool) Required

  If reset_password is true, send email

• password (string)

  When auth_type is LOCAL, password is required.

• name (string)

• email (string)

• language (string)

  en,ko

• timezone (string)

  UTC, Asia/Seoul

• tags (Struct)

DisableUserMFARequest

• user_id (string) Required

MFA

• state (State) Required

• mfa_type (string) Required

• options (Struct) Required

SetRequiredActionsRequest

• user_id (string) Required

• required_actions (UserRequiredAction) Repeated Required

UpdateUserRequest

• user_id (string) Required

• password (string)

• name (string)

• email (string)

• language (string)

• timezone (string)

• tags (Struct)

• reset_password (bool)

UserInfo

• user_id (string) Required

• name (string) Required

• state (State) Required

• email (string) Required

• email_verified (bool) Required

• auth_type (AuthType) Required

• role_id (string) Required

• role_type (RoleType) Required

• mfa (MFA) Required

• language (string) Required

• timezone (string) Required

• required_actions (UserRequiredAction) Repeated Required

• tags (Struct) Required

• domain_id (string) Required

• created_at (string) Required

• last_accessed_at (string) Required

UserRequest

• user_id (string) Required

UserSearchQuery

• query (Query)

• user_id (string)

• name (string)

• state (State)

• email (string)

• auth_type (AuthType)

UserStatQuery

• query (StatisticsQuery) Required

UsersInfo

• results (UserInfo) Repeated Required

• total_count (int32) Required

VerifyUserEmailRequest

• user_id (string) Required

• email (string)