Api Key

Package : spaceone.api.identity.v1

APIKey

APIKey Methods:

NO	Method	Request Type	Response Type	Description
1	create	CreateAPIKeyRequest	APIKeyInfo
2	enable	APIKeyRequest	APIKeyInfo
3	disable	APIKeyRequest	APIKeyInfo
4	update_role	UpdateAPIKeyRoleRequest	APIKeyInfo
5	update_allowed_hosts	UpdateAPIKeyHostsRequest	APIKeyInfo
6	delete	APIKeyRequest	google.protobuf.Empty
7	get	GetAPIKeyRequest	APIKeyInfo
8	list	APIKeyQuery	APIKeysInfo
9	stat	APIKeyStatQuery	google.protobuf.Struct

create

POST /identity/v1/api-keys

Type	Message
Request	CreateAPIKeyRequest
Response	APIKeyInfo

enable

PUT /identity/v1/api-key/{api_key_id}/enable

Type	Message
Request	APIKeyRequest
Response	APIKeyInfo

disable

PUT /identity/v1/api-key/{api_key_id}/disable

Type	Message
Request	APIKeyRequest
Response	APIKeyInfo

update_role

PUT /identity/v1/api-key/{api_key_id}/roles

Type	Message
Request	UpdateAPIKeyRoleRequest
Response	APIKeyInfo

update_allowed_hosts

PUT /identity/v1/api-key/{api_key_id}/allowed-hosts

Type	Message
Request	UpdateAPIKeyHostsRequest
Response	APIKeyInfo

delete

DELETE /identity/v1/api-key/{api_key_id}

Type	Message
Request	APIKeyRequest
Response	google.protobuf.Empty

get

GET /identity/v1/api-key/{api_key_id}

Type	Message
Request	GetAPIKeyRequest
Response	APIKeyInfo

list

GET /identity/v1/api-keys

POST /identity/v1/api-keys/search

Type	Message
Request	APIKeyQuery
Response	APIKeysInfo

stat

POST /identity/v1/api-keys/stat

Type	Message
Request	APIKeyStatQuery
Response	google.protobuf.Struct

Message

APIKeyInfo

No	Field	Type	Required	Description
1	api_key_id	string
2	api_key	string
3	state	APIKeyInfo.State NONE_STATE ENABLED DISABLED
4	user_id	string	APIKeyType api_key_type = 4;	APIKeyType api_key_type = 4;
5	domain_id	string
6	allowed_hosts	Acls	repeated spaceone.api.identity.v1.RoleInfo roles = 7;	repeated spaceone.api.identity.v1.RoleInfo roles = 7;
7	last_accessed_at	google.protobuf.Timestamp
8	created_at	google.protobuf.Timestamp

APIKeyQuery

No	Field	Type	Required	Description
1	api_key_id	string
2	state	APIKeyQuery.State NONE_STATE ENABLED DISABLED
3	api_key_type	APIKeyQuery.APIKeyType NONE_TYPE USER SYSTEM DELEGATION DOMAIN
4	user_id	string
5	query	spaceone.api.core.v1.Query
6	domain_id	string

APIKeyRequest

No	Field	Type	Required	Description
1	api_key_id	string		required
2	domain_id	string		required

APIKeyStatQuery

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

APIKeysInfo

No	Field	Type	Required	Description
1	results	APIKeyInfo
2	total_count	int32

Acls

No	Field	Type	Required	Description
1	name	string		optional
2	cidr	string		required

CreateAPIKeyRequest

No	Field	Type	Required	Description
1	api_key_type	CreateAPIKeyRequest.APIKeyType NONE USER SYSTEM DELEGATION DOMAIN	required	required
2	user_id	string	required	required
3	domain_id	string	required	required

GetAPIKeyRequest

No	Field	Type	Required	Description
1	api_key_id	string		required
2	domain_id	string		required
3	only	string		optional

UpdateAPIKeyHostsRequest

No	Field	Type	Required	Description
1	api_key_id	string
2	allowed_hosts	Acls
3	domain_id	string

UpdateAPIKeyRoleRequest

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