User Channel

Package : spaceone.api.notification.v1

UserChannel

UserChannel Methods:

NO

Method

Request Type

Response Type

Description

1

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.

2

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.

3

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.

4

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.

5

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.

6

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

7

Delete the User Channel.

8

Gets a single User Channel.

9

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.

10

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

Response

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

Response

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.

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.

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

Response

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

Response

delete

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

Delete the User Channel.

Type

Message

Request

Response

get

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

Gets a single User Channel.

Type

Message

Request

Response

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

Response

stat

POST /notification/v1/user-channels/stat

Message

CreateUserChannelRequest

No

Field

Type

Required

Description

1

protocol_id

string

The ID of protocol that will be set in user channel.

2

name

string

The name of User Channel. It can have a maximum of 255 characters.

3

data

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.

4

is_subscribe

bool

Indicates whether subscriptions will be used.

5

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.

6

is_scheduled

bool

Indicates whether schedule will be used.

7

schedule

Schedule for which you want to receive notifications through the user channel.

8

tags

The tags for user channel.

9

user_id

string

The ID of user

10

domain_id

string

The ID of domain.

GetUserChannelRequest

No

Field

Type

Required

Description

1

user_channel_id

string

The ID of user channel.

2

domain_id

string

The ID of domain.

3

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

No

Field

Type

Required

Description

1

user_channel_id

string

The ID of user channel.

2

name

string

The name of user channel. It can have a maximum of 255 characters.

3

data

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.

4

schedule

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.

5

tags

The tags for user channel.

6

domain_id

string

The ID of domain.

UpdateUserChannelScheduleRequest

No

Field

Type

Required

Description

1

user_channel_id

string

The ID of user channel.

2

is_scheduled

bool

Indicates whether schedule will be used.

3

schedule

Schedule for which you want to receive notifications through the user channel.

4

domain_id

string

The ID of domain.

UpdateUserChannelSubscriptionRequest

No

Field

Type

Required

Description

1

user_channel_id

string

The ID of user channel.

2

is_subscribe

bool

Indicates whether subscriptions will be used.

3

subscriptions

list of string

4

domain_id

string

The ID of domain.

UserChannelInfo

No

Field

Type

Description

1

user_channel_id

string

The ID of user channel.

2

name

string

The name of user channel

3

state

  • NONE

  • ENABLED

  • DISABLED

The state of user channel. ENABLED or DISABLED only.

4

data

The data for using user channel.

5

secret_id

string

The ID of secret encrypted data in the security service

6

is_subscribe

bool

Indicates whether subscriptions will be used.

7

subscriptions

list of string

The topic list to subscription.

8

is_scheduled

bool

Indicates whether schedule will be used.

9

schedule

Schedule for which you want to receive notifications through the user channel.

10

tags

The tags for user channel.

11

protocol_id

string

The ID of protocol set in the user channel.

12

user_id

string

The ID of user using the user channel.

13

domain_id

string

The ID of domain.

14

created_at

string

User channel creation time.

UserChannelQuery

No

Field

Type

Required

Description

1

query

Query format provided by SpaceONE. Please check the link for more information.

2

user_channel_id

string

The ID of user channel.

3

name

string

The name of user channel. It can have a maximum of 255 characters.

4

state

  • NONE

  • ENABLED

  • DISABLED

The state of user channel. ENABLED or DISABLED only.

5

secret_id

string

6

protocol_id

string

The ID of protocol set in the user channel.

7

user_id

string

The ID of user using the user channel.

8

domain_id

string

The ID of domain.

UserChannelRequest

No

Field

Type

Required

Description

1

user_channel_id

string

The ID of user channel.

2

domain_id

string

The ID of domain.

UserChannelSchedule

No

Field

Type

Description

1

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.

2

start_hour

Start time to receive notifications.Only integer type can be set, and 0 to 23 can be.

3

end_hour

End time to receive notifications.Only integer type can be set, and 1 to 24 can be.

UserChannelStatQuery

No

Field

Type

Required

Description

1

query

Statistics Query format provided by SpaceONE. Please check the link for more information.

2

domain_id

string

The ID of domain.

UserChannelsInfo

No

Field

Type

Description

1

results

List of queried user channels.

2

total_count

Total counts of queried user channels.

Last updated