User

User API which allows member management within project, company, and domain

Package : spaceone.api.identity.v1

User

User Methods:

Method	Request	Response
create	CreateUserRequest	UserInfo
update	UpdateUserRequest	UserInfo
set_required_actions	SetRequiredActionsRequest	UserInfo
enable	UserRequest	UserInfo
disable	UserRequest	UserInfo
delete	UserRequest	google.protobuf.Empty
get	GetUserRequest	UserInfo
list	UserQuery	UsersInfo
stat	UserStatQuery	google.protobuf.Struct
find	FindUserQuery	FindUsersInfo
sync	UserRequest	UserInfo

create

POST /identity/v1/users

Type	Message
Request	CreateUserRequest
Response	UserInfo

update

PUT /identity/v1/users

Update user info by given user_id

Type	Message
Request	UpdateUserRequest
Response	UserInfo

Request Example

{
    "user_id": "[e-mail]",
    "tags": [
        {
            "key": "user1",
            "value": "Reuters"
        },
        {
            "key": "user2",
            "value": "Bloomberg"
        }
    ],
    "domain_id": "{{DOMAIN_ID}}"
}

Response Example

{
    "user_id": "[e-mail]",
    "name": "Dong Yoo kang",
    "state": "ENABLED",
    "email": "[e-mail]",
    "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"
}

set_required_actions

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

Type	Message
Request	SetRequiredActionsRequest
Response	UserInfo

enable

PUT /identity/v1/user/{user_id}/enable

Type	Message
Request	UserRequest
Response	UserInfo

disable

PUT /identity/v1/user/{user_id}/disable

Type	Message
Request	UserRequest
Response	UserInfo

delete

DELETE /identity/v1/users

Type	Message
Request	UserRequest
Response	google.protobuf.Empty

get

GET /identity/v1/user/{user_id}

Type	Message
Request	GetUserRequest
Response	UserInfo

list

GET /identity/v1/users

POST /identity/v1/users/search

Type	Message
Request	UserQuery
Response	UsersInfo

stat

POST /identity/v1/users/stat

Type	Message
Request	UserStatQuery
Response	google.protobuf.Struct

find

POST /identity/v1/users/find

Type	Message
Request	FindUserQuery
Response	FindUsersInfo

sync

POST /identity/v1/users/sync

Type	Message
Request	UserRequest
Response	UserInfo

Message

CreateUserRequest

Field	Type	Required	Description
user_id	string	✔
password	string	✘
name	string	✘
email	string	✘
user_type	NONE_USER_TYPE USER API_USER	✘
backend	NONE_BACKEND LOCAL EXTERNAL	✔
language	string	✘
timezone	string	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔

FindUserInfo

Field	Type	Description
user_id	string
name	string
email	string
tags	google.protobuf.Struct

FindUserQuery

Field	Type	Required	Description
search	FindUserSearch	✔
domain_id	string	✔

FindUserSearch

Field	Type	Description
user_id	string
keyword	string

FindUsersInfo

Field	Type	Description
results	list of FindUserInfo
total_count	int32

GetUserRequest

Field	Type	Required	Description
user_id	string	✔
domain_id	string	✔
only	list of string	✘

SetRequiredActionsRequest

Field	Type	Required	Description
user_id	string	✔
actions	UPDATE_PASSWORD	✔
domain_id	string	✔

UpdateUserRequest

Field	Type	Required	Description
user_id	string	✔
password	string	✘
name	string	✘
email	string	✘
language	string	✘
timezone	string	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔

UserInfo

Field	Type	Description
user_id	string
name	string
state	NONE ENABLED DISABLED PENDING
email	string
user_type	NONE_USER_TYPE USER API_USER
backend	NONE_BACKEND LOCAL EXTERNAL
language	string
timezone	string
required_actions	UPDATE_PASSWORD
tags	google.protobuf.Struct
last_accessed_at	string
created_at	string
domain_id	string

UserQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
user_id	string	✘
name	string	✘
state	string	✘
email	string	✘
user_type	NONE_USER_TYPE USER API_USER	✘
backend	NONE_BACKEND LOCAL EXTERNAL	✘
domain_id	string	✘

UserRequest

Field	Type	Required	Description
user_id	string	✔
domain_id	string	✔

UserStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔

UsersInfo

Field	Type	Description
results	list of UserInfo
total_count	int32