User

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

Package : spaceone.api.identity.v1

User

User Methods:

MethodRequestResponse

create

CreateUserRequest

UserInfo

update

UpdateUserRequest

UserInfo

verify_email

VerifyEmailRequest

Empty

confirm_email

ConfirmEmailRequest

UserInfo

reset_password

UserRequest

Empty

set_required_actions

SetRequiredActionsRequest

UserInfo

enable_mfa

EnableMFARequest

UserInfo

disable_mfa

DisableMFARequest

UserInfo

confirm_mfa

ConfirmMFARequest

UserInfo

enable

UserRequest

UserInfo

disable

UserRequest

UserInfo

delete

UserRequest

Empty

get

GetUserRequest

UserInfo

list

UserQuery

UsersInfo

stat

UserStatQuery

Struct

find

FindUserQuery

FindUsersInfo

sync

UserRequest

UserInfo

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/v1/user/create

{{< tabs " create " >}}

{{< tab "Request Example" >}}

CreateUserRequest

  • user_id (string) Required

  • backend (UserBackend) Required

  • domain_id (string) Required

  • password (string)

    When backend is LOCAL, password is required.

  • name (string)

  • email (string)

  • user_type (UserType)

  • language (string)

    en,ko

  • timezone (string)

    UTC, Asia/Seoul

  • tags (Struct)

  • reset_password (bool)

    If reset_password is true, send email

{{< highlight json >}} { "user_id": "example@cloudforet.com", "password": "password", "name": "Wonny", "email": "example@cloudforet.com", "user_type": "USER", "backend": "LOCAL", "language": "en", "timezone": "UTC", "tags": { "Department": "Development" } } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

update

Update user info by given user_id

POST /identity/v1/user/update

{{< tabs " update " >}}

{{< tab "Request Example" >}}

UpdateUserRequest

  • user_id (string) Required

  • domain_id (string) Required

  • password (string)

  • name (string)

  • email (string)

  • language (string)

  • timezone (string)

  • tags (Struct)

  • reset_password (bool)

{{< highlight json >}} { "user_id": "example@cloudforet.com", "tags": { "Department": "Development", "Role" }, "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

verify_email

POST /identity/v1/user/verify-email

confirm_email

POST /identity/v1/user/confirm-email

{{< tabs " confirm_email " >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

reset_password

+noauth

POST /identity/v1/user/reset-password

set_required_actions

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

{{< tabs " set_required_actions " >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

enable_mfa

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

POST /identity/v1/user/enable-mfa

{{< tabs " enable_mfa " >}}

{{< tab "Request Example" >}}

EnableMFARequest

  • user_id (string) Required

  • 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.

  • domain_id (string) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "mfa_type": "EMAIL", "options": {"email": "wonny@cloudforet.com"}, "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

disable_mfa

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

POST /identity/v1/user/disable-mfa

{{< tabs " disable_mfa " >}}

{{< tab "Request Example" >}}

DisableMFARequest

  • user_id (string) Required

  • domain_id (string) Required

  • force (bool)

    If this value true, disable MFA without verification for user.

{{< highlight json >}} { "user_id": "example@cloudforet.com", "force": false, "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

confirm_mfa

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

POST /identity/v1/user/confirm-mfa

{{< tabs " confirm_mfa " >}}

{{< tab "Request Example" >}}

ConfirmMFARequest

  • user_id (string) Required

  • verify_code (string) Required

  • domain_id (string) Required

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

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

enable

POST /identity/v1/user/enable

{{< tabs " enable " >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

disable

POST /identity/v1/user/disable

{{< tabs " disable " >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

delete

POST /identity/v1/user/delete

get

POST /identity/v1/user/get

{{< tabs " get " >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

POST /identity/v1/user/list

stat

POST /identity/v1/user/stat

find

POST /identity/v1/user/find

sync

POST /identity/v1/user/sync

{{< tabs " sync " >}}

{{< tab "Response Example" >}}

UserInfo

  • user_id (string) Required

  • name (string) Required

  • state (State) Required

  • email (string) Required

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

{{< highlight json >}} { "user_id": "example@cloudforet.com", "name": "Wonny", "state": "ENABLED", "email": "Wonny@cloudforet.com", "email_verified" : true, "mfa": { "mfa_type": "EMAIL", "state" : "ENABLED", "options": { "email": "example@cloudforet.com" } }, "language": "en", "timezone": "UTC", "tags": { "Department": "Development", "Role" }, "last_accessed_at": "2023-01-01T07:12:41.890Z" "created_at": "2023-01-01T15:23:31.705Z" "domain_id": "domain-xxxxxxxxxxxx" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

Message

ConfirmEmailRequest

  • user_id (string) Required

  • verify_code (string) Required

  • domain_id (string) Required

ConfirmMFARequest

  • user_id (string) Required

  • verify_code (string) Required

  • domain_id (string) Required

CreateUserRequest

  • user_id (string) Required

  • backend (UserBackend) Required

  • domain_id (string) Required

  • password (string)

    When backend is LOCAL, password is required.

  • name (string)

  • email (string)

  • user_type (UserType)

  • language (string)

    en,ko

  • timezone (string)

    UTC, Asia/Seoul

  • tags (Struct)

  • reset_password (bool)

    If reset_password is true, send email

DisableMFARequest

  • user_id (string) Required

  • domain_id (string) Required

  • force (bool)

    If this value true, disable MFA without verification for user.

EnableMFARequest

  • user_id (string) Required

  • 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.

  • domain_id (string) Required

FindUserInfo

  • user_id (string) Required

  • name (string) Required

  • email (string) Required

  • tags (Struct) Required

FindUserQuery

  • search (FindUserSearch) Required

  • domain_id (string) Required

FindUserSearch

  • user_id (string) Required

  • keyword (string) Required

FindUsersInfo

  • results (FindUserInfo) Repeated Required

  • total_count (int32) Required

GetUserRequest

  • user_id (string) Required

  • domain_id (string) Required

  • only (string) Repeated

MFA

  • state (MFAState) Required

  • mfa_type (string) Required

  • options (Struct) Required

SetRequiredActionsRequest

  • user_id (string) Required

  • actions (UserRequiredAction) Repeated Required

  • domain_id (string) Required

UpdateUserRequest

  • user_id (string) Required

  • domain_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

  • user_type (UserType) Required

  • backend (UserBackend) Required

  • language (string) Required

  • timezone (string) Required

  • required_actions (UserRequiredAction) Repeated Required

  • tags (Struct) Required

  • last_accessed_at (string) Required

  • created_at (string) Required

  • domain_id (string) Required

  • email_verified (bool) Required

  • mfa (MFA) Required

UserQuery

  • query (Query)

  • user_id (string)

  • name (string)

  • state (string)

  • email (string)

  • user_type (UserType)

  • backend (UserBackend)

  • domain_id (string)

UserRequest

  • user_id (string) Required

  • domain_id (string) Required

UserStatQuery

  • query (StatisticsQuery) Required

  • domain_id (string) Required

UsersInfo

  • results (UserInfo) Repeated Required

  • total_count (int32) Required

VerifyEmailRequest

  • user_id (string) Required

  • domain_id (string) Required

  • email (string)

  • force (bool)

PreviousTokenNextv1

Last updated