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	delete	UserRequest	google.protobuf.Empty
6	get	GetUserRequest	UserInfo
7	list	UserQuery	UsersInfo
8	stat	UserStatQuery	google.protobuf.Struct
9	find	FindUserQuery	FindUsersInfo
10	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"
}

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

No	Field	Type	Required	Description
1	user_id	string	✅
2	password	string	❌
3	name	string	❌
4	email	string	❌
5	user_type	NONE_USER_TYPE USER API_USER	❌
6	backend	NONE_BACKEND LOCAL EXTERNAL	✅
7	language	string	❌
8	timezone	string	❌
9	tags	list of spaceone.api.core.v1.Tag	❌
10	domain_id	string	✅

FindUserInfo

No	Field	Type	Description
1	user_id	string
2	name	string
3	email	string
4	tags	list of spaceone.api.core.v1.Tag

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	language	string	❌
6	timezone	string	❌
7	tags	list of spaceone.api.core.v1.Tag	❌
8	domain_id	string	✅

UserInfo

No	Field	Type	Description
1	user_id	string
2	name	string
3	state	NONE ENABLED DISABLED PENDING
4	email	string
5	user_type	NONE_USER_TYPE USER API_USER
6	backend	NONE_BACKEND LOCAL EXTERNAL
7	language	string
8	timezone	string
9	tags	list of spaceone.api.core.v1.Tag
10	last_accessed_at	google.protobuf.Timestamp
11	created_at	google.protobuf.Timestamp
12	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	user_type	NONE_USER_TYPE USER API_USER	❌
7	backend	NONE_BACKEND LOCAL EXTERNAL	❌
8	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