User

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

Package : spaceone.api.identity.v1

User

User Methods:

create

POST /identity/v1/users

Type

Message

Request

Response

update

PUT /identity/v1/users

Update user info by given user_id

Type

Message

Request

Response

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

enable

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

Type

Message

Request

Response

disable

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

Type

Message

Request

Response

delete

DELETE /identity/v1/users

Type

Message

Request

Response

get

GET /identity/v1/user/{user_id}

Type

Message

Request

Response

list

GET /identity/v1/users

POST /identity/v1/users/search

Type

Message

Request

Response

stat

POST /identity/v1/users/stat

Type

Message

Request

Response

find

POST /identity/v1/users/find

Type

Message

Request

Response

sync

POST /identity/v1/users/sync

Type

Message

Request

Response

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

2

domain_id

string

FindUserSearch

No

Field

Type

Description

1

user_id

string

2

keyword

string

FindUsersInfo

No

Field

Type

Description

1

results

2

total_count

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

11

created_at

12

domain_id

string

UserQuery

No

Field

Type

Required

Description

1

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

2

domain_id

string

UsersInfo

No

Field

Type

Description

1

results

2

total_count

Last updated