User Channel

Package : spaceone.api.notification.v1

UserChannel

UserChannel Methods:

Method	Request	Response
create	CreateUserChannelRequest	UserChannelInfo
update	UpdateUserChannelRequest	UserChannelInfo
set_schedule	UpdateUserChannelScheduleRequest	UserChannelInfo
set_subscription	UpdateUserChannelSubscriptionRequest	UserChannelInfo
enable	UserChannelRequest	UserChannelInfo
disable	UserChannelRequest	UserChannelInfo
delete	UserChannelRequest	google.protobuf.Empty
get	GetUserChannelRequest	UserChannelInfo
list	UserChannelQuery	UserChannelsInfo
stat	UserChannelStatQuery	google.protobuf.Struct

create

POST /notification/v1/user-channels

Creates a new User Channel.User channel is the definition of the channel that delivers the notification to users when the notification is created.When creating a User Channel, one of the protocols must be selected, and an notification is dispatched through the selected protocol.

Type	Message
Request	CreateUserChannelRequest
Response	UserChannelInfo

update

PUT /notification/v1/user-channel/{user_channel_id}

Updates a User Channel information.Protocol that has already been set cannot be changed. Instead, the data required to be dispatched notification for user channel is can be updated.

Type	Message
Request	UpdateUserChannelRequest
Response	UserChannelInfo

set_schedule

PUT /notification/v1/user-channel/{user_channel_id}/schedule

Schedule settings for user channels.When a notification is created, you can set the day and time you want to receive it through the schedule.When you set the day of the week in the schedule, you can receive a notification only on the set day of the week.If you also set the start time and end time with day of the week, you can receive a notification only at the set time on the set day of the week.If there is no schedule, notifications will be dispatched at all times through user channel.

Type	Message
Request	UpdateUserChannelScheduleRequest
Response	UserChannelInfo

set_subscription

PUT /notification/v1/user-channel/{user_channel_id}/subscription

Subscription settings for user channelsIf the user channel have subscriptions, notification is dispatched only if the topic of the notification is the same as the one set in the subscriptions.If no subscriptions in user channel, notifications will be dispatched all.

Type	Message
Request	UpdateUserChannelSubscriptionRequest
Response	UserChannelInfo

enable

PUT /notification/v1/user-channel/{user_channel_id}/enable

Enables a User Channel.If the disabled user channel is enabled, the user channel can be used again and the notification can be dispatched.Even if the user channel is enabled, if the protocol being used in the user channel is disabled, the notification is not dispatched.

Type	Message
Request	UserChannelRequest
Response	UserChannelInfo

disable

PUT /notification/v1/user-channel/{user_channel_id}/disable

Disables a User Channel.If you disable the user channel, the notification will not be dispatched, even if they are created.

Type	Message
Request	UserChannelRequest
Response	UserChannelInfo

delete

DELETE /notification/v1/user-channel/{user_channel_id}

Delete the User Channel.

Type	Message
Request	UserChannelRequest
Response	google.protobuf.Empty

get

GET /notification/v1/user-channel/{user_channel_id}

Gets a single User Channel.

Type	Message
Request	GetUserChannelRequest
Response	UserChannelInfo

list

GET /notification/v1/user-channels

POST /notification/v1/user-channels/search

Lists the specified User Channel.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	UserChannelQuery
Response	UserChannelsInfo

stat

POST /notification/v1/user-channels/stat

Type	Message
Request	UserChannelStatQuery
Response	google.protobuf.Struct

Message

CreateUserChannelRequest

Field	Type	Required	Description
protocol_id	string	✔	The ID of protocol that will be set in user channel.
name	string	✔	The name of User Channel. It can have a maximum of 255 characters.
data	google.protobuf.Struct	✔	The data for using user channel.This data is encrypted and stored in the Secret service if JSON schema in the protocol's metadata is set to SECRET type.In this case, the secret ID that is stored in the security service will be returned and the data value will be empty.if JSON schema in the protocol's metadata is set to PLAIN_TEXT type, This data is not encrypted and stored directly in the DB.
is_subscribe	bool	✘	Indicates whether subscriptions will be used.
subscriptions	list of string	✔	When using subscriptions, it indicates the topic list to subscription.If is_subscribe is set to false, this value is ignored.
is_scheduled	bool	✘	Indicates whether schedule will be used.
schedule	UserChannelSchedule	✘	Schedule for which you want to receive notifications through the user channel.
tags	google.protobuf.Struct	✘	The tags for user channel.
user_id	string	✔	The ID of user
domain_id	string	✔	The ID of domain.

GetUserChannelRequest

Field	Type	Required	Description
user_channel_id	string	✔	The ID of user channel.
domain_id	string	✔	The ID of domain.
only	list of string	✘	The list of the user channel information column you want to be returned. It must be specified in the UserChannelInfo.

UpdateUserChannelRequest

Field	Type	Required	Description
user_channel_id	string	✔	The ID of user channel.
name	string	✘	The name of user channel. It can have a maximum of 255 characters.
data	google.protobuf.Struct	✔	The data for using user channel.This data is encrypted and stored in the Secret service if JSON schema in the protocol's metadata is set to SECRET type.In this case, the secret ID that is stored in the security service will be returned and the data value will be empty.if JSON schema in the protocol's metadata is set to PLAIN_TEXT type, This data is not encrypted and stored directly in the DB.
schedule	UserChannelSchedule	✔	Set the level of notification.If a notification has a level and a notification level that this channel can receive is set, a notification is dispatched only if the notification level is the same.
tags	google.protobuf.Struct	✘	The tags for user channel.
domain_id	string	✔	The ID of domain.

UpdateUserChannelScheduleRequest

Field	Type	Required	Description
user_channel_id	string	✔	The ID of user channel.
is_scheduled	bool	✔	Indicates whether schedule will be used.
schedule	UserChannelSchedule	✘	Schedule for which you want to receive notifications through the user channel.
domain_id	string	✔	The ID of domain.

UpdateUserChannelSubscriptionRequest

Field	Type	Required	Description
user_channel_id	string	✔	The ID of user channel.
is_subscribe	bool	✔	Indicates whether subscriptions will be used.
subscriptions	list of string	✔
domain_id	string	✔	The ID of domain.

UserChannelInfo

Field	Type	Description
user_channel_id	string	The ID of user channel.
name	string	The name of user channel
state	NONE ENABLED DISABLED	The state of user channel. ENABLED or DISABLED only.
data	google.protobuf.Struct	The data for using user channel.
secret_id	string	The ID of secret encrypted data in the security service
is_subscribe	bool	Indicates whether subscriptions will be used.
subscriptions	list of string	The topic list to subscription.
is_scheduled	bool	Indicates whether schedule will be used.
schedule	UserChannelSchedule	Schedule for which you want to receive notifications through the user channel.
tags	google.protobuf.Struct	The tags for user channel.
protocol_id	string	The ID of protocol set in the user channel.
user_id	string	The ID of user using the user channel.
domain_id	string	The ID of domain.
created_at	string	User channel creation time.

UserChannelQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘	Query format provided by SpaceONE. Please check the link for more information.
user_channel_id	string	✘	The ID of user channel.
name	string	✘	The name of user channel. It can have a maximum of 255 characters.
state	NONE ENABLED DISABLED	✘	The state of user channel. ENABLED or DISABLED only.
secret_id	string	✔
protocol_id	string	✘	The ID of protocol set in the user channel.
user_id	string	✘	The ID of user using the user channel.
domain_id	string	✔	The ID of domain.

UserChannelRequest

Field	Type	Required	Description
user_channel_id	string	✔	The ID of user channel.
domain_id	string	✔	The ID of domain.

UserChannelSchedule

Field	Type	Description
day_of_week	NONE MON TUE WED THU FRI SAT SUN	Day of the week to be notified.As a list type, only types that can be specified from MON to SUN can be set.
start_hour	int32	Start time to receive notifications.Only integer type can be set, and 0 to 23 can be.
end_hour	int32	End time to receive notifications.Only integer type can be set, and 1 to 24 can be.

UserChannelStatQuery

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.

UserChannelsInfo

Field	Type	Description
results	list of UserChannelInfo	List of queried user channels.
total_count	int32	Total counts of queried user channels.