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:

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

{
 "user_id": "wonny@cloudforet.io",
 "password": "Password1234!",
 "name": "Wonny",
 "email": "wonny@cloudforet.io",
 "auth_type": "LOCAL",
 "language": "en",
 "timezone": "UTC"
}

update #

Update user info by given user_id

POST /identity/v2/user/update

verify_email #

POST /identity/v2/user/verify-email

{
 "user_id": "example@cloudforet.com",
 "email": "example@cloudforet.com",
}

disable_mfa #

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

POST /identity/v2/user/disable-mfa

{
 "user_id": "example@cloudforet.com"
}

set_required_actions #

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

{
 "user_id": "example@cloudforet.com",
 "required_actions": ["UPDATE_PASSWORD"]
}

set_refresh_timeout #

Sets the user’s refresh token timeout. This API can only be used by users with the DOMAIN_ADMIN role. Min value is 1800 seconds and max value is 2592000 seconds

POST /identity/v2/user/set-refresh-timeout

{
  "user_id": "wony@cloudforet.io"
  "refresh_token_timout": 10800
}

enable #

POST /identity/v2/user/enable

{
 "user_id": "example@cloudforet.com"
}

disable #

POST /identity/v2/user/disable

{
 "user_id": "example@cloudforet.com"
}

delete #

POST /identity/v2/user/delete

{
 "user_id": "example@cloudforet.com"
}

get #

POST /identity/v2/user/get

{
 "user_id": "example@cloudforet.com"
}

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)

  
  

DisableMFAUserRequest #

• user_id (string) Required

  
  

MFA #

• state (State) Required

• mfa_type (string) Required

• options (Struct) Required

  
  

SetRefreshTimeout #

• user_id (string) Required

• refresh_timeout (int32) Required

  
  

SetRequiredActionsUserRequest #

• 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

• refresh_timeout (int32) 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

  
  

VerifyEmailUserRequest #

• user_id (string) Required

• email (string)