User

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
createCreateUserRequestUserInfo
updateUpdateUserRequestUserInfo
verify_emailVerifyEmailRequestEmpty
confirm_emailConfirmEmailRequestUserInfo
reset_passwordUserRequestEmpty
set_required_actionsSetRequiredActionsRequestUserInfo
enableUserRequestUserInfo
disableUserRequestUserInfo
deleteUserRequestEmpty
getGetUserRequestUserInfo
listUserQueryUsersInfo
statUserStatQueryStruct
findFindUserQueryFindUsersInfo
syncUserRequestUserInfo

create #

POST /identity/v1/user/create

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

{
   "user_id": "dkang@mz.co.kr",
   "name": "Dong Yoo kang",
   "state": "ENABLED",
   "email": "dkang@mz.co.kr",
   "language": "en",
   "timezone": "UTC",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "last_accessed_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "created_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "domain_id": "domain-fd6e23a5ae36"
}

update #

Update user info by given user_id

POST /identity/v1/user/update

UpdateUserRequest

  • user_id (string) Required

  • domain_id (string) Required

  • password (string)

  • name (string)

  • email (string)

  • language (string)

  • timezone (string)

  • tags (Struct)

  • reset_password (bool)

{
 "user_id": "dkang@mz.co.kr",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "domain_id": "{{DOMAIN_ID}}"
}

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

{
   "user_id": "dkang@mz.co.kr",
   "name": "Dong Yoo kang",
   "state": "ENABLED",
   "email": "dkang@mz.co.kr",
   "language": "en",
   "timezone": "UTC",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "last_accessed_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "created_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "domain_id": "domain-fd6e23a5ae36"
}

verify_email #

POST /identity/v1/user/verify-email


confirm_email #

POST /identity/v1/user/confirm-email

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

{
   "user_id": "dkang@mz.co.kr",
   "name": "Dong Yoo kang",
   "state": "ENABLED",
   "email": "dkang@mz.co.kr",
   "language": "en",
   "timezone": "UTC",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "last_accessed_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "created_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "domain_id": "domain-fd6e23a5ae36"
}

reset_password #

POST /identity/v1/user/reset-password


set_required_actions #

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

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

{
   "user_id": "dkang@mz.co.kr",
   "name": "Dong Yoo kang",
   "state": "ENABLED",
   "email": "dkang@mz.co.kr",
   "language": "en",
   "timezone": "UTC",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "last_accessed_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "created_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "domain_id": "domain-fd6e23a5ae36"
}

enable #

POST /identity/v1/user/enable

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

{
   "user_id": "dkang@mz.co.kr",
   "name": "Dong Yoo kang",
   "state": "ENABLED",
   "email": "dkang@mz.co.kr",
   "language": "en",
   "timezone": "UTC",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "last_accessed_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "created_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "domain_id": "domain-fd6e23a5ae36"
}

disable #

POST /identity/v1/user/disable

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

{
   "user_id": "dkang@mz.co.kr",
   "name": "Dong Yoo kang",
   "state": "ENABLED",
   "email": "dkang@mz.co.kr",
   "language": "en",
   "timezone": "UTC",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "last_accessed_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "created_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "domain_id": "domain-fd6e23a5ae36"
}

delete #

POST /identity/v1/user/delete


get #

POST /identity/v1/user/get

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

{
   "user_id": "dkang@mz.co.kr",
   "name": "Dong Yoo kang",
   "state": "ENABLED",
   "email": "dkang@mz.co.kr",
   "language": "en",
   "timezone": "UTC",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "last_accessed_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "created_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "domain_id": "domain-fd6e23a5ae36"
}

list #

POST /identity/v1/user/list


stat #

POST /identity/v1/user/stat


find #

POST /identity/v1/users/find


sync #

POST /identity/v1/user/sync

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

{
   "user_id": "dkang@mz.co.kr",
   "name": "Dong Yoo kang",
   "state": "ENABLED",
   "email": "dkang@mz.co.kr",
   "language": "en",
   "timezone": "UTC",
   "tags": [{
     "key": "user1",
     "value": "Reuters"
   }, {
     "key": "user2",
     "value": "Bloomberg"
   }],
   "last_accessed_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "created_at": {
       "seconds": "1593161630",
       "nanos": 79000000
   },
   "domain_id": "domain-fd6e23a5ae36"
}


Message #

ConfirmEmailRequest #

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

  • name (string)

  • email (string)

  • user_type (UserType)

  • language (string)

  • timezone (string)

  • tags (Struct)

  • reset_password (bool)


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


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


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)


Calendar September 22, 2023
Edit Edit this page

Documentation Distributed under CC BY 4.0

Copyright © Cloudforet a Series of LF Projects, LLC. For website terms of use, trademark policy and other project policies please see https://lfprojects.org.