Jump to

• Request
• Response
• Examples

Create/Update theme properties for a locale

put

/oaa-drss/v1/themes/{locale}

Create or Update theme properties for a locale. Any properties that don't exist are created.

Request

Path Parameters

• locale(required): string
  The locale for the theme

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• properties(required): object ThemeProperties
  Key-value pairs of theme properties
• status(required): integer
  Allowed Values: [ 0, 1 ]

  Status of the theme properties (1 for active, 0 for inactive)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"Status of the theme properties (1 for active, 0 for inactive)",
            "enum":[
                0,
                1
            ]
        },
        "properties":{
            "$ref":"#/components/schemas/ThemeProperties"
        }
    },
    "required":[
        "status",
        "properties"
    ]
}

Nested Schema : ThemeProperties

Type: object

Key-value pairs of theme properties

Show Source

• CPFT_COMMAND_LINK_FORGOT_PASSWORD: string
  Example: Forgot password
• CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD: string
  Example: Login with password

{
    "type":"object",
    "description":"Key-value pairs of theme properties",
    "properties":{
        "CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD":{
            "type":"string",
            "example":"Login with password"
        },
        "CPFT_COMMAND_LINK_FORGOT_PASSWORD":{
            "type":"string",
            "example":"Forgot password"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• properties(required): object ThemeProperties
  Key-value pairs of theme properties
• status(required): integer
  Allowed Values: [ 0, 1 ]

  Status of the theme properties (1 for active, 0 for inactive)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"Status of the theme properties (1 for active, 0 for inactive)",
            "enum":[
                0,
                1
            ]
        },
        "properties":{
            "$ref":"#/components/schemas/ThemeProperties"
        }
    },
    "required":[
        "status",
        "properties"
    ]
}

Nested Schema : ThemeProperties

Type: object

Key-value pairs of theme properties

Show Source

• CPFT_COMMAND_LINK_FORGOT_PASSWORD: string
  Example: Forgot password
• CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD: string
  Example: Login with password

{
    "type":"object",
    "description":"Key-value pairs of theme properties",
    "properties":{
        "CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD":{
            "type":"string",
            "example":"Login with password"
        },
        "CPFT_COMMAND_LINK_FORGOT_PASSWORD":{
            "type":"string",
            "example":"Forgot password"
        }
    }
}

Back to Top

Response

204 Response

Updated theme properties for the given locale

400 Response

Bad Request - Invalid input data or locale

401 Response

Unauthorized Access

404 Response

Theme not found for the given locale

500 Response

Internal server error

Back to Top

Examples

The following example shows a sample request and response for creating or updating a theme for a locale.

cURL Command to Create or Update a Theme For a Locale in JSON Format

curl --location --request PUT '<DRSS>/v1/themes/en_US' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--header 'Content-Type: application/json' \
--data '{
    "status": 1,
    "properties": {
        "Logo": "Qk2KsAEAAAAAAIoAAAB8AAAAwAAAAMAAAAABABgAAAAAAetc..",
        "CPFT_TILE_IMAGE": "Login with Example Company Username",
        "CPFT_EDIT_TEXT_DEFAULT": "Example Company Username",
        "CPFT_PASSWORD_TEXT": "Example Company Password",
        "CPFT_SMALL_TEXT": "Choose a factor to login:",
        "CPFT_COMMAND_LINK_LOGIN_WITH_PASSWORD": "Login with your password",
        "CPFT_COMMAND_LINK_NOT_USER": "Click if Not",
        "CPFT_COMMAND_LINK_FORGOT_PASSWORD": "Forgot your password?",
        "CPFT_COMMAND_LINK_CHANGE_PASSWORD": "Change your password?",
        "CPFT_COMMAND_LINK_SIGN_IN_OPTION" : "Login with another factor",
        "OUACP_ERR_MSG_0000": "Example Company Universal Authenticator",
        "OUACP_ERR_MSG_0001": "Incorrect Microsoft Windows Credentials, please try again.",
        "OUACP_ERR_MSG_0002": "User access is denied. Please contact your administrator.",
        "OUACP_ERR_MSG_0004": "Did not receive approval from device. Please retry.",
        "OUACP_ERR_MSG_0006": "Password validation failed. Please retry.",
        "OUACP_ERR_MSG_0007": "The system is currently offline. Enter your password to proceed. Not all features will be available. To restore all features, please logout and login again when system is online.",
        "OUACP_ERR_MSG_0008": "The device for this user is blocked. Please contact your administrator.",
        "OUACP_ERR_MSG_0009": "Device is blocked for all users. Please contact your administrator."
    }
}'

Sample Response in JSON Format

No response is returned except 204 No Content.

Back to Top