Is AI recommending you? Ask Contentstack Canoe for free
Is AI recommending your brand? Find out with Contentstack Canoe for free
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Contentstack for Developers
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • The Forrester Wave™: Digital Experience Platforms, Q4 2025
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Lytics API
  4. Auths
  5. Liveramp_Userkey

Liveramp_Userkey

markdownView as Markdown

Create and manage credentials and access to external systems.

Liveramp_Userkey: Create auth

POSThttps://api.lytics.io/v2/auth/liveramp-userkey

Create a Liveramp_Userkey auth

Sample Request
1234567891011121314151617
{
  "account_id": "string",
  "config": {
    "folder": "string",
    "host": "string",
    "passphrase": "string",
    "port": 0,
    "privatekey": "string",
    "user": "string"
  },
  "description": "string",
  "label": "string",
  "provider_id": "string",
  "provider_slug": "string",
  "type": "string",
  "user_id": "string"
}
Sample Response
Status|201 Created
123456789101112131415161718192021222324252627
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "alert_enabled": true,
    "created": "string",
    "description": "string",
    "expires": "string",
    "id": "string",
    "internal": true,
    "label": "string",
    "last_accessed_at": "string",
    "provider_id": "string",
    "provider_slug": "string",
    "scopes": [
      "string"
    ],
    "status": "healthy",
    "ttl": "string",
    "type": "string",
    "unhealthy": true,
    "updated": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Liveramp_Userkey: Get auth

GEThttps://api.lytics.io/v2/auth/liveramp-userkey/{id}

Get a Liveramp_Userkey auth

Sample Response
Status|200 OK
123456789101112131415161718192021222324252627
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "alert_enabled": true,
    "created": "string",
    "description": "string",
    "expires": "string",
    "id": "string",
    "internal": true,
    "label": "string",
    "last_accessed_at": "string",
    "provider_id": "string",
    "provider_slug": "string",
    "scopes": [
      "string"
    ],
    "status": "healthy",
    "ttl": "string",
    "type": "string",
    "unhealthy": true,
    "updated": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}

Liveramp_Userkey: Update auth

PUThttps://api.lytics.io/v2/auth/liveramp-userkey/{id}

Update a Liveramp_Userkey auth

Sample Request
1234567891011121314151617
{
  "account_id": "string",
  "config": {
    "folder": "string",
    "host": "string",
    "passphrase": "string",
    "port": 0,
    "privatekey": "string",
    "user": "string"
  },
  "description": "string",
  "label": "string",
  "provider_id": "string",
  "provider_slug": "string",
  "type": "string",
  "user_id": "string"
}
Sample Response
Status|200 OK
123456789101112131415161718192021222324252627
{
  "_meta": {},
  "data": {
    "account_id": "string",
    "alert_enabled": true,
    "created": "string",
    "description": "string",
    "expires": "string",
    "id": "string",
    "internal": true,
    "label": "string",
    "last_accessed_at": "string",
    "provider_id": "string",
    "provider_slug": "string",
    "scopes": [
      "string"
    ],
    "status": "healthy",
    "ttl": "string",
    "type": "string",
    "unhealthy": true,
    "updated": "string",
    "user_id": "string"
  },
  "request_id": "string",
  "status": 0
}
Hide Parameters

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

account_idoptionalstring

Lytics Account ID

configrequiredobject

The type-specific configuration for the authorization

config.folderoptionalstring

Relative path to the folder to place the csv. Leave blank to place the csv in the home directory.

config.hostoptionalstring
config.passphraseoptionalstring
config.portoptionalinteger
config.privatekeyoptionalstring
config.useroptionalstring
descriptionoptionalstring

A client-defined description for the authorization

labelrequiredstring

A client-defined label for the authorization

provider_idoptionalstring

The authorization's provider ID

provider_slugoptionalstring

The authorization's provider slug

typeoptionalstring

The auth type. Providers may have one or more auth types

user_idoptionalstring

The user ID that created or updated the authorization

Hide Parameters

URL Parameters

idrequiredstring

The Authorization ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Hide Parameters

URL Parameters

idrequiredstring

The Authorization ID

Query Parameters

account_idoptionalstring

The account ID. Defaults to the user's default account.

Headers

Authorizationoptionalstring

Body Parameters

account_idoptionalstring

Lytics Account ID

configrequiredobject

The type-specific configuration for the authorization

config.folderoptionalstring

Relative path to the folder to place the csv. Leave blank to place the csv in the home directory.

config.hostoptionalstring
config.passphraseoptionalstring
config.portoptionalinteger
config.privatekeyoptionalstring
config.useroptionalstring
descriptionoptionalstring

A client-defined description for the authorization

labelrequiredstring

A client-defined label for the authorization

provider_idoptionalstring

The authorization's provider ID

provider_slugoptionalstring

The authorization's provider slug

typeoptionalstring

The auth type. Providers may have one or more auth types

user_idoptionalstring

The user ID that created or updated the authorization