REST API for Content Management

Generate an OAuth Token

post

/content/management/api/v1.1/channels/{id}/oauthToken

for given channel

Request

Path Parameters

id: string

Generates an OAuth token for the given channelId

Header Parameters

X-Requested-With: string

A custom header to mitigate CSRF attacks.

Allowed Values: [ "XMLHttpRequest" ]

Channel Secret of the channel to generate OAuth Token

Root Schema : ChannelSecret

Type: object

Channel Secret

Show Source

channelSecret: string

channel secret

{
    "type":"object",
    "required":[
        "channelSecret"
    ],
    "properties":{
        "channelSecret":{
            "type":"string",
            "description":"channel secret"
        }
    },
    "description":"Channel Secret"
}

Response

Supported Media Types

application/json

201 Response

Created.

Root Schema : OAuthToken

Type: object

OAuth Token

Show Source

channelId: string

the channel ID for whom this token is being generated
expiration(optional): string(date-time)

the token expiration date
token(optional): string

oauth token

{
    "type":"object",
    "required":[
        "channelId"
    ],
    "properties":{
        "token":{
            "type":"string",
            "description":"oauth token"
        },
        "channelId":{
            "type":"string",
            "description":"the channel ID for whom this token is being generated"
        },
        "expiration":{
            "type":"string",
            "format":"date-time",
            "description":"the token expiration date"
        }
    },
    "description":"OAuth Token"
}

400 Response

Bad request.

403 Response

Forbidden.

500 Response

Internal server error.

Examples

The following example shows how to create an OAuth token for the given channel secret by submitting a POST request on the REST resource using cURL.

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/channels/{id}/oauthToken'

Example:

Returns valid OAuth encrypted bearer token.

/content/management/api/v1.1/channels/CC793A08B59F65C5FEB7A460B93FC83D8390695C8E93/oauthToken

Request Payload

{
  "channelSecret": "mBMSPvumV4y8dpdkPz/pA+7Nr2t/ITF9wTcWt94sDMk="
}

Response Body

{
  "token": "eyJ4NXQjUzI1NiI6ImFHSG1laWY3T1g0Nnd3U180QVZtc096RmtfMWlnd0ozQURLa29DRkNTT0kiLCJ4NXQiOiJ2U0VkYi0teDBvR1FHSXBKYmdQSVUzOVd3U1kiLCJraWQiOiJTSUdOSU5HX0tFWSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0RDg4RTAyMTM1QTk0N0FEOUJGODVEQUJGMDcwMjYxQ19BUFBJRCIsInVzZXIudGVuYW50Lm5hbWUiOiJpZGNzLTFjZTA5Zjk1NDk5MTQyNGRiN2M2MTkxMGUxYjY0NmMwIiwic3ViX21hcHBpbmdhdHRyIjoidXNlck5hbWUiLCJwcmltVGVuYW50Ijp0cnVlLCJpc3MiOiJodHRwczpcL1wvaWRlbnRpdHkub3JhY2xlY2xvdWQuY29tXC8iLCJ0b2tfdHlwZSI6IkFUIiwiY2xpZW50X2lkIjoiNEQ4OEUwMjEzNUE5NDdBRDlCRjg1REFCRjA3MDI2MUNfQVBQSUQiLCJjYV9ndWlkIjoiY2FjY3QtZTY4NThjNDI3MzFlNGRjZTlhYTA1NjY3NTAzOTVjZjciLCJhdWQiOlsidXJuOm9wYzpsYmFhczpsb2dpY2FsZ3VpZD00RDg4RTAyMTM1QTk0N0FEOUJGODVEQUJGMDcwMjYxQyIsImh0dHBzOlwvXC80RDg4RTAyMTM1QTk0N0FEOUJGODVEQUJGMDcwMjYxQy5jZWMuZGV2Lm9jcC5vYy10ZXN0LmNvbTo0NDNcLyIsImh0dHBzOlwvXC80RDg4RTAyMTM1QTk0N0FEOUJGODVEQUJGMDcwMjYxQy5jZWMuZGV2Lm9jcC5vYy10ZXN0LmNvbTo0NDNcL2RvY3VtZW50c1wvaW50ZWdyYXRpb25cL3NvY2lhbCIsImh0dHBzOlwvXC80RDg4RTAyMTM1QTk0N0FEOUJGODVEQUJGMDcwMjYxQy5jZWMuZGV2Lm9jcC5vYy10ZXN0LmNvbTo0NDNcL29zblwvc29jaWFsXC9hcGkiXSwic3ViX3R5cGUiOiJjbGllbnQiLCJzY29wZSI6InVybjpvcGM6Y2VjOmFsbCIsImNsaWVudF90ZW5hbnRuYW1lIjoiaWRjcy0xY2UwOWY5NTQ5OTE0MjRkYjdjNjE5MTBlMWI2NDZjMCIsImV4cCI6MTU2MTcxNTM4NywiaWF0IjoxNTYxMTEwNTg3LCJ0ZW5hbnRfaXNzIjoiaHR0cHM6XC9cL2lkY3MtMWNlMDlmOTU0OTkxNDI0ZGI3YzYxOTEwZTFiNjQ2YzAuaWRlbnRpdHkuYzlkZXYxLm9jOXFhZGV2LmNvbSIsImNsaWVudF9ndWlkIjoiZjE3MTM5OWVlYjBlNDVkZjk4ZTI1YzYxOGFlN2ZkN2MiLCJjbGllbnRfbmFtZSI6IkNFQ1NBVVRPX3Axb2NpdWNtMDUxNGFkMXNydmM1IiwidGVuYW50IjoiaWRjcy0xY2UwOWY5NTQ5OTE0MjRkYjdjNjE5MTBlMWI2NDZjMCIsImp0aSI6IjE5YWM5ODE4LWQ1OTEtNGFmMy05OTQxLTZkOTQ1ZTEyOTgxZiJ9.Rc3UP7CDhbGV4lDZbIj8TNejYZ0EYbE1YsvAZS8Ghm28XcBKOeb_iUxipt0XxH3EblsFsw98009LtSabDadSqLe7DFZ3HdZ6fnYYc1UqYYTCElbXQ39aNcqW3V7M5NFPZYPEsStZyAu5-LXvNtJpRb2_KCu0xSNoNmE10dg56ZqocNgX8s2L4HgI84OugdwUKRUkdzdv8dtDnPbY2xdz_kEB_5BWs0nOl_WWALx-9rJn5e-9Umg9BsQVnPob74ViL2pWHOZB_VYw31i3cBUPHEIRC-bluwzz_NGIQQkI9WSWfP1BtXf2nmrKeRZ_zcwkzELi1ASYv7NlWf4X3dOupw",
  "channelId": "CC793A08B59F65C5FEB7A460B93FC83D8390695C8E93",
  "expiration": {
    "value": "2019-06-28T09:49:47.000Z",
    "timezone": "UTC"
  }
}