Technology Partners

POST a User Under a Partner's SSO-Enabled Client Account

Changed on

Use this endpoint to create a new user under a partner client account that has the Single Sign On (SSO) for all users feature enabled.

post/partner/accounts/{encoded_account_id}/users/sso

Request

  • Base URL
    https://api.cc.email/v3
  • URL
    https://api.cc.email/v3/partner/accounts/{encoded_account_id}/users/sso
  • Auth
    OAuth 2 and API key in header x-api-key
    Implicit: https://v3api-partner.auth.us-east-1.amazoncognito.com/oauth2/token

Path parameters

encoded_account_idstring required

The encoded account ID that identifies the partner's client account to which to add the new user.

Request body

first_namestring required

The client account user's first name.

last_namestring required

The client account user's last name.

role_namestring required

The role (<code>account_manager</code> or <code>campaign_creator</code>) to assign the client account user.

contact_emailstring required

The unique email address to associate with the new client account user.

login_namestring required

The login name to associate with the new client account user.

external_idstring required

The unique ID used to identify the client account user to the external authenticator.

external_providerstring required

The unique name used to identify the external provider used to authenticate the client account user. For a list of external providers, contact the Constant Contact Partner Team.

Example request

{
  "first_name": "Josie",
  "last_name": "Lang",
  "role_name": "campaign_creator",
  "contact_email": "josie.lang@gmail.com",
  "login_name": "josie.lang",
  "external_id": "23378234122161121",
  "external_provider": "Yahoo"
}

Response

Request successful.

Changes

  • 2483585c5d89Revision changes
    • info

      the endpoint scheme security ctctPartnerAuthorizer AND api_key was added to the API

    • info

      the endpoint scheme security api_key was removed from the API

    • info

      the endpoint scheme security ctctPartnerAuthorizer was removed from the API

  • 1bb1d071befbRevision changes
    • info

      endpoint added