Interface ITemplatesClient

A client that works with Okta Template resources.

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public interface ITemplatesClient

Methods

CreateSmsTemplateAsync(ISmsTemplate, CancellationToken)

Adds a new custom SMS template to your organization.

Declaration

Task<ISmsTemplate> CreateSmsTemplateAsync(ISmsTemplate smsTemplate, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ISmsTemplate	smsTemplate	The ISmsTemplate resource.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<ISmsTemplate>	The ISmsTemplate response.

DeleteSmsTemplateAsync(String, CancellationToken)

Removes an SMS template.

Declaration

Task DeleteSmsTemplateAsync(string templateId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	templateId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

GetSmsTemplateAsync(String, CancellationToken)

Fetches a specific template by id

Declaration

Task<ISmsTemplate> GetSmsTemplateAsync(string templateId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	templateId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<ISmsTemplate>	The ISmsTemplate response.

ListSmsTemplates(SmsTemplateType)

Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.

Declaration

ICollectionClient<ISmsTemplate> ListSmsTemplates(SmsTemplateType templateType = null)

Parameters

Type	Name	Description
SmsTemplateType	templateType

Returns

Type	Description
ICollectionClient<ISmsTemplate>	A collection of ISmsTemplate that can be enumerated asynchronously.

PartialUpdateSmsTemplateAsync(ISmsTemplate, String, CancellationToken)

Updates only some of the SMS template properties:

Declaration

Task<ISmsTemplate> PartialUpdateSmsTemplateAsync(ISmsTemplate smsTemplate, string templateId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ISmsTemplate	smsTemplate	The ISmsTemplate resource.
System.String	templateId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<ISmsTemplate>	The ISmsTemplate response.

UpdateSmsTemplateAsync(ISmsTemplate, String, CancellationToken)

Updates the SMS template.

Declaration

Task<ISmsTemplate> UpdateSmsTemplateAsync(ISmsTemplate smsTemplate, string templateId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
ISmsTemplate	smsTemplate	The ISmsTemplate resource.
System.String	templateId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<ISmsTemplate>	The ISmsTemplate response.