User

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

Package : spaceone.api.identity.v1

User

User Methods:

NO	Method	Request Type	Response Type	Description
1	create	CreateUserRequest	UserInfo
2	update	UpdateUserRequest	UserInfo	Update user info by given user_id
3	enable	UserRequest	UserInfo
4	disable	UserRequest	UserInfo
5	update_role	UpdateUserRoleRequest	UserInfo
6	delete	UserRequest	google.protobuf.Empty
7	get	GetUserRequest	UserInfo
8	list	UserQuery	UsersInfo
9	stat	UserStatQuery	google.protobuf.Struct
10	find	FindUserQuery	FindUsersInfo
11	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": {
        "user1": "Reuters",
        "user2": "Bloomberg"
    },
    "domain_id": "{{DOMAIN_ID}}"
}

Response Example

{
    "roles": [],
    "user_id": "[e-mail]",
    "name": "Dong Yoo kang",
    "state": "ENABLED",
    "email": "[e-mail]",
    "mobile": "",
    "group": "",
    "language": "en",
    "timezone": "UTC",
    "tags": {
        "user1": "Reuters",
        "user2": "Bloomberg"
    },
    "last_accessed_at": {
        "seconds": "1593161630",
        "nanos": 79000000
    },
    "created_at": {
        "seconds": "1593161630",
        "nanos": 79000000
    },
    "domain_id": "domain-fd6e23a5ae36"
}

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

update_role

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

Type	Message
Request	UpdateUserRoleRequest
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

No	Field	Type	Required	Description
1	user_id	string	✅
2	password	string	❌
3	name	string	❌
4	email	string	❌
5	mobile	string	❌
6	group	string	❌
7	language	string	❌
8	timezone	string	❌
9	tags	google.protobuf.Struct	❌
10	domain_id	string	✅

FindUserInfo

No	Field	Type	Description
1	user_id	string
2	name	string
3	email	string
4	mobile	string
5	group	string
6	state	string

FindUserQuery

No	Field	Type	Required	Description
1	search	FindUserSearch	✅
2	domain_id	string	✅

FindUserSearch

No	Field	Type	Description
1	user_id	string
2	keyword	string

FindUsersInfo

No	Field	Type	Description
1	results	list of FindUserInfo
2	total_count	int32

GetUserRequest

No	Field	Type	Required	Description
1	user_id	string	✅
2	domain_id	string	✅
3	only	list of string	❌

UpdateUserRequest

No	Field	Type	Required	Description
1	user_id	string	✅
2	password	string	❌
3	name	string	❌
4	email	string	❌
5	mobile	string	❌
6	group	string	❌
7	language	string	❌
8	timezone	string	❌
9	tags	google.protobuf.Struct	❌
10	domain_id	string	✅

UpdateUserRoleRequest

No	Field	Type	Required	Description
1	user_id	string	✅
2	roles	google.protobuf.ListValue	✅
3	domain_id	string	✅

UserInfo

No	Field	Type	Description
1	user_id	string
2	name	string
3	state	NONE ENABLED DISABLED UNIDENTIFIED
4	email	string
5	mobile	string
6	group	string
7	language	string
8	timezone	string
9	roles	list of RoleInfo
10	tags	google.protobuf.Struct
11	last_accessed_at	google.protobuf.Timestamp
12	created_at	google.protobuf.Timestamp
13	domain_id	string

UserQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.Query	❌
2	user_id	string	❌
3	name	string	❌
4	state	string	❌
5	email	string	❌
6	mobile	string	❌
7	group	string	❌
8	role_id	string	❌
9	domain_id	string	❌

UserRequest

No	Field	Type	Required	Description
1	user_id	string	✅
2	domain_id	string	✅

UserStatQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.StatisticsQuery	✅
2	domain_id	string	✅

UsersInfo

No	Field	Type	Description
1	results	list of UserInfo
2	total_count	int32