The SMS Templates API provides operations to manage custom SMS templates for verification.
Note: Only SMS custom Templates are available through the API.
SMS Templates customize the SMS message that is sent to users. One default SMS Template is provided. All custom Templates must have the variable ${code}
as part of the text. The ${code}
variable is replaced with the actual SMS code when the message is sent. Optionally, you can also use the variable ${org.name}
. If a Template contains ${org.name}
, it is replaced with the organization name before the SMS message is sent.
okta.templates.read
Lists all custom SMS templates. A subset of templates can be returned that match a template type.
Success
Forbidden
Too Many Requests
[- {
- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
]
okta.templates.manage
Creates a new custom SMS template
Success
Bad Request
Forbidden
Too Many Requests
{- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
okta.templates.read
Retrieves a specific template by id
Success
Forbidden
Not Found
Too Many Requests
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
okta.templates.manage
Updates an SMS template
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
okta.templates.manage
Replaces the SMS template
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "template": "string",
- "translations": { },
- "type": "SMS_VERIFY_CODE"
}
okta.templates.manage
Deletes an SMS template
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}