Protocol

Package : spaceone.api.notification.v1
Protocol
Protocol Methods:
Method
Request
Response
​create​
​CreateProtocolRequest​
​ProtocolInfo​
​update​
​UpdateProtocolRequest​
​ProtocolInfo​
​update_plugin​
​UpdateProtocolPluginRequest​
​ProtocolInfo​
​enable​
​ProtocolRequest​
​ProtocolInfo​
​disable​
​ProtocolRequest​
​ProtocolInfo​
​delete​
​ProtocolRequest​
​google.protobuf.Empty​
​get​
​GetProtocolRequest​
​ProtocolInfo​
​list​
​ProtocolQuery​
​ProtocolsInfo​
​stat​
​ProtocolStatQuery​
​google.protobuf.Struct​
create
POST /notification/v1/protocols
Creates a new Protocol.Protocol is the definition of which method to use when dispatching the Notifications through a Channel.When creating a protocol, you must specify the plugins provided from the repository, and you must also set the credentials to be set in the plugin if necessary.
Type
Message
Request
​CreateProtocolRequest​
Response
​ProtocolInfo​
update
PUT /notification/v1/protocol/{protocol_id}
Updates a Protocol information.Update methods can update name, tags only. If you want to update plugin version or options, you can use update_plugin method.
Type
Message
Request
​UpdateProtocolRequest​
Response
​ProtocolInfo​
update_plugin
PUT /notification/v1/protocol/{protocol_id}/plugin
Updates a plugin for Protocol.This method is usually used when redeploying a deployed plugin container to a new version.
Type
Message
Request
​UpdateProtocolPluginRequest​
Response
​ProtocolInfo​
enable
PUT /notification/v1/protocol/{protocol_id}/enable
Enables a Protocol.If the disabled Protocol is enabled, the Protocol can be used again and the notification can be dispatched.
Type
Message
Request
​ProtocolRequest​
Response
​ProtocolInfo​
disable
PUT /notification/v1/protocol/{protocol_id}/disable
Disables a Protocol.If you disable the Protocol, the notification will not be dispatched, even if they are created.
Type
Message
Request
​ProtocolRequest​
Response
​ProtocolInfo​
delete
DELETE /notification/v1/protocol/{protocol_id}
Delete the protocol.If there is even one channel using the protocol, it cannot be deleted.
Type
Message
Request
​ProtocolRequest​
Response
​google.protobuf.Empty​
get
GET /notification/v1/protocol/{protocol_id}
Gets a single Protocol.
Type
Message
Request
​GetProtocolRequest​
Response
​ProtocolInfo​
list
GET /notification/v1/protocols
POST /notification/v1/protocols/search
Lists the specified Protocols.Can search information using the query format provided by SpaceONE.Detailed information about Query format can be checked in the Search Query pages.
Type
Message
Request
​ProtocolQuery​
Response
​ProtocolsInfo​
stat
POST /notification/v1/protocols/stat
Type
Message
Request
​ProtocolStatQuery​
Response
​google.protobuf.Struct​
​
Message
CreateProtocolRequest
Field
Type
Required
Description
name
string
✔
The name of Protocol. It can have a maximum of 255 characters.
plugin_info
​PluginRequest​
✔
Describe a Plugin information for protocol that include was used plugin, specific version, schema etc.
tags
​google.protobuf.Struct​
✘
The tags for protocol.
domain_id
string
✔
The ID of domain to which the Protocol belongs.
GetProtocolRequest
Field
Type
Required
Description
protocol_id
string
✔
The ID of Protocol.
domain_id
string
✔
The ID of domain to which the Protocol belongs.
only
list of string
✘
The list of the Protocol information column you want to be returned. It must be specified in the ProtocolInfo.
PluginInfo
Field
Type
Description
plugin_id
string
The ID of plugin set in the Protocol.
version
string
The version of plugin.
options
​google.protobuf.Struct​
The Options that contains information about using plugin.
secret_id
string
The ID of the Secret containing encrypted data to be used in the plugin.
metadata
​google.protobuf.Struct​
The metadata of plugin. It includes schema for the data that must be set for the Channel when creating the Channel using a Protocol.The schema follows the JSON Schema format.
upgrade_mode
NONE
AUTO
MANUAL
Auto upgrade for plugin.If the upgrade_mode is AUTO, check the latest plugin version when running the plugin, and if a new version is existed, replace the plugin and then run it.
PluginRequest
Field
Type
Required
Description
plugin_id
string
✔
The ID of plugin.
version
string
✔
The version of plugin.
options
​google.protobuf.Struct​
✘
The Options that contains information about using plugin.
secret_data
​google.protobuf.Struct​
✘
The data for using plugin if necessary. This data is encrypted and stored in the Secret service.
schema
string
✔
The name of schema.When the secret_data is stored in the Secret service, it can be set with schema if the schema is existed.The schema is provided through the Repository service.
upgrade_mode
NONE
AUTO
MANUAL
✔
Auto upgrade feature for plugin.If the upgrade mode is AUTO, check the latest plugin version when running the plugin, and if a new version is existed, replace the plugin and then run it.
ProtocolInfo
Field
Type
Description
protocol_id
string
The ID of Protocol.
name
string
The name of Protocol.
state
NONE
ENABLED
DISABLED
The state of Protocol.ENABLED or DISABLED only.
protocol_type
PROTOCOL_TYPE_NONE
INTERNAL
EXTERNAL
{}
resource_type
string
Resource type for Protocol. Currently only identity.Project or identity.User can be set.
capability
​google.protobuf.Struct​
The capability information for the Protocol. It included supported schema for the Protocol.
plugin_info
​PluginInfo​
the plugin information set in Protocol.
tags
​google.protobuf.Struct​
The tags for protocol.
domain_id
string
The ID of domain to which the Protocol belongs.
created_at
string
Protocol creation time.
ProtocolQuery
Field
Type
Required
Description
query
​spaceone.api.core.v1.Query​
✘
Query format provided by SpaceONE. Please check the link for more information.
protocol_id
string
✘
The ID of Protocol.
name
string
✘
The name of Protocol.
state
NONE
ENABLED
DISABLED
✘
The state of Protocol. ENABLED or DISABLED only.
protocol_type
PROTOCOL_TYPE_NONE
INTERNAL
EXTERNAL
✘
The type of Protocol. INTERNAL or EXTERNAL only.
domain_id
string
✔
The ID of domain to which the Protocol belongs.
ProtocolRequest
Field
Type
Required
Description
protocol_id
string
✔
The ID of Protocol.
domain_id
string
✔
The ID of domain to which the Protocol belongs.
ProtocolStatQuery
Field
Type
Required
Description
query
​spaceone.api.core.v1.StatisticsQuery​
✔
Statistics Query format provided by SpaceONE. Please check the link for more information.
domain_id
string
✔
The ID of domain to which the Protocol belongs.
ProtocolsInfo
Field
Type
Description
results
​list of ProtocolInfo​
List of queried protocols.
total_count
​int32​
Total counts of queried Protocols.
UpdateProtocolPluginRequest
Field
Type
Required
Description
protocol_id
string
✔
The ID of Protocol.
version
string
✘
The version of plugin you want to update. Version means the tags of plugin container image in repository that specific market place.
options
​google.protobuf.Struct​
✘
The Options that contains information about using plugin.
domain_id
string
✔
The ID of domain to which the Protocol belongs.
UpdateProtocolRequest
Field
Type
Required
Description
protocol_id
string
✔
The ID of Protocol.
name
string
✘
The Name of Protocol. It can have a maximum of 255 characters.
tags
​google.protobuf.Struct​
✘
The tags for protocol. When updating, existing tag information is deleted all and will be updated with new.
domain_id
string
✔
The ID of domain to which the Protocol belongs.

Method	Request	Response
create	CreateProtocolRequest	ProtocolInfo
update	UpdateProtocolRequest	ProtocolInfo
update_plugin	UpdateProtocolPluginRequest	ProtocolInfo
enable	ProtocolRequest	ProtocolInfo
disable	ProtocolRequest	ProtocolInfo
delete	ProtocolRequest	google.protobuf.Empty
get	GetProtocolRequest	ProtocolInfo
list	ProtocolQuery	ProtocolsInfo
stat	ProtocolStatQuery	google.protobuf.Struct

Type	Message
Request	CreateProtocolRequest
Response	ProtocolInfo

Type	Message
Request	UpdateProtocolRequest
Response	ProtocolInfo

Type	Message
Request	UpdateProtocolPluginRequest
Response	ProtocolInfo

Type	Message
Request	ProtocolRequest
Response	ProtocolInfo

Type	Message
Request	ProtocolRequest
Response	ProtocolInfo

Type	Message
Request	ProtocolRequest
Response	google.protobuf.Empty

Type	Message
Request	GetProtocolRequest
Response	ProtocolInfo

Type	Message
Request	ProtocolQuery
Response	ProtocolsInfo

Type	Message
Request	ProtocolStatQuery
Response	google.protobuf.Struct

Field	Type	Required	Description
name	string	✔	The name of Protocol. It can have a maximum of 255 characters.
plugin_info	PluginRequest	✔	Describe a Plugin information for protocol that include was used plugin, specific version, schema etc.
tags	google.protobuf.Struct	✘	The tags for protocol.
domain_id	string	✔	The ID of domain to which the Protocol belongs.

Field	Type	Required	Description
protocol_id	string	✔	The ID of Protocol.
domain_id	string	✔	The ID of domain to which the Protocol belongs.
only	list of string	✘	The list of the Protocol information column you want to be returned. It must be specified in the ProtocolInfo.

Field	Type	Description
plugin_id	string	The ID of plugin set in the Protocol.
version	string	The version of plugin.
options	google.protobuf.Struct	The Options that contains information about using plugin.
secret_id	string	The ID of the Secret containing encrypted data to be used in the plugin.
metadata	google.protobuf.Struct	The metadata of plugin. It includes schema for the data that must be set for the Channel when creating the Channel using a Protocol.The schema follows the JSON Schema format.
upgrade_mode	NONE AUTO MANUAL	Auto upgrade for plugin.If the upgrade_mode is AUTO, check the latest plugin version when running the plugin, and if a new version is existed, replace the plugin and then run it.

Field	Type	Required	Description
plugin_id	string	✔	The ID of plugin.
version	string	✔	The version of plugin.
options	google.protobuf.Struct	✘	The Options that contains information about using plugin.
secret_data	google.protobuf.Struct	✘	The data for using plugin if necessary. This data is encrypted and stored in the Secret service.
schema	string	✔	The name of schema.When the secret_data is stored in the Secret service, it can be set with schema if the schema is existed.The schema is provided through the Repository service.
upgrade_mode	NONE AUTO MANUAL	✔	Auto upgrade feature for plugin.If the upgrade mode is AUTO, check the latest plugin version when running the plugin, and if a new version is existed, replace the plugin and then run it.

Field	Type	Description
protocol_id	string	The ID of Protocol.
name	string	The name of Protocol.
state	NONE ENABLED DISABLED	The state of Protocol.ENABLED or DISABLED only.
protocol_type	PROTOCOL_TYPE_NONE INTERNAL EXTERNAL	{}
resource_type	string	Resource type for Protocol. Currently only identity.Project or identity.User can be set.
capability	google.protobuf.Struct	The capability information for the Protocol. It included supported schema for the Protocol.
plugin_info	PluginInfo	the plugin information set in Protocol.
tags	google.protobuf.Struct	The tags for protocol.
domain_id	string	The ID of domain to which the Protocol belongs.
created_at	string	Protocol creation time.

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘	Query format provided by SpaceONE. Please check the link for more information.
protocol_id	string	✘	The ID of Protocol.
name	string	✘	The name of Protocol.
state	NONE ENABLED DISABLED	✘	The state of Protocol. ENABLED or DISABLED only.
protocol_type	PROTOCOL_TYPE_NONE INTERNAL EXTERNAL	✘	The type of Protocol. INTERNAL or EXTERNAL only.
domain_id	string	✔	The ID of domain to which the Protocol belongs.

Field	Type	Required	Description
protocol_id	string	✔	The ID of Protocol.
domain_id	string	✔	The ID of domain to which the Protocol belongs.

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔	Statistics Query format provided by SpaceONE. Please check the link for more information.
domain_id	string	✔	The ID of domain to which the Protocol belongs.

Field	Type	Description
results	list of ProtocolInfo	List of queried protocols.
total_count	int32	Total counts of queried Protocols.

Field	Type	Required	Description
protocol_id	string	✔	The ID of Protocol.
version	string	✘	The version of plugin you want to update. Version means the tags of plugin container image in repository that specific market place.
options	google.protobuf.Struct	✘	The Options that contains information about using plugin.
domain_id	string	✔	The ID of domain to which the Protocol belongs.

Field	Type	Required	Description
protocol_id	string	✔	The ID of Protocol.
name	string	✘	The Name of Protocol. It can have a maximum of 255 characters.
tags	google.protobuf.Struct	✘	The tags for protocol. When updating, existing tag information is deleted all and will be updated with new.
domain_id	string	✔	The ID of domain to which the Protocol belongs.

Project Channel

Quota

Last modified 1yr ago

Protocol

Protocol

create

update

update_plugin

enable

disable

delete

get

list

stat

​

Message

CreateProtocolRequest

GetProtocolRequest

PluginInfo

PluginRequest

ProtocolInfo

ProtocolQuery

ProtocolRequest

ProtocolStatQuery

ProtocolsInfo

UpdateProtocolPluginRequest

UpdateProtocolRequest