External Two squares, one overlapping the bottom one. Top square has an arrow pointing away, as if leading you away

User profiles

Overview

User profiles in Zywave represent additional information about a user and their relationship with different contexts of Zywave's software. Profiles bring with them additional "claims" (i.e. user data points) that can be used to make other APIs calls or present information to a user.

Note: Profiles and users are not the same thing! While these claims are made available, user-related claims like "email address" or "given name" should be extracted from the user identity claims as provided by Zywave's identity provider.

The type of a profile is an enumerated value that indicates different contexts used for data access, feature access, and in some situations system preferences.

The following are the supported profile type codes:

We'll go into detail below on what each of these profile types are and how they are used.

Profile types

Partner profile

TypeCode: B

A partner profile is a profile that represents a user's relationship with a partner. This concept is otherwise referred to as an agency and an agency user. For direct customer relationships with Zywave, this is the profile type that is used to indicate which customer a user is interacting with.

Claims

All claims for this claim type are under the namespace urn:zywave:profile:b.

Expand to view claims
Claim Name Description
urn:zywave:profile:b:brokerid Agency Id The ID of the agency that the user is associated with.
urn:zywave:profile:b:organizationid Organization Id The ID of the organization that this agency belongs to.
urn:zywave:profile:b:emailaddress Email Address The email address of the profile. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:b:givenname Given Name The given name of the profile. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:b:middleinitial Middle Initial The middle initial of the profile. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:b:surname Surname The surnamce of the profile. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:b:title Title The title of the profile (i.e. Mr., Ms., etc.)
urn:zywave:profile:b:phonenumber Phone Number The phone number of th e profile.
urn:zywave:profile:b:fax Fax Number The fax number of the profile.
urn:zywave:profile:b:brokername Agency Name The name of the agency.
urn:zywave:profile:b:brokercity Agency City The city of the agency.
urn:zywave:profile:b:brokerstate Agency State The state of the agency.
urn:zywave:profile:b:administrator Is Administrator OBSOLETE OBSOLETE This claim has been deprecated since 2021 in favor of feature permissions. Its usage is not recommended and it will be removed in a future release.

Client profile

TypeCode: C

A client profile is a profile that represents a user's relationship with a client (i.e. a customer of a partner). This is otherwise referred to as an account and account contact. This profile type is used to indicate which account a user is interacting with.

These profiles are typically used by client's to access Zywave's Client Cloud software, primarily the Client Cloud Portal, the Client Cloud Toolbox, etc.

Note: Client profiles are not used for Zywave's LMS. For the LMS, see the Employer profile section below.

Claims

All claims for this claim type are under the namespace urn:zywave:profile:c.

Expand to view claims
Claim Name Description
urn:zywave:profile:c:accountid Account Id The ID of the account that the user is associated with.
urn:zywave:profile:c:brokerId Agency Id The ID of the agency that the account belongs to.
urn:zywave:profile:c:accountName Account Name The name of the account.
urn:zywave:profile:c:accountCity Account City The city of the account.
urn:zywave:profile:c:accountState Account State The state of the account.
urn:zywave:profile:c:accountPostalCode Account Postal Code The postal code of the account.
urn:zywave:profile:c:addressLine1 Address Line 1 The first line of the account's address.
urn:zywave:profile:c:addressLine2 Address Line 2 The second line of the account's address.
urn:zywave:profile:c:addressLine3 Address Line 3 The third line of the account's address.
urn:zywave:profile:c:city City The city of the account.
urn:zywave:profile:c:country Country The country of the account.
urn:zywave:profile:c:county County The county of the account.
urn:zywave:profile:c:emailAddress Email Address The email address of the client. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:c:faxnumber Fax Number The fax number of the client.
urn:zywave:profile:c:givenName Given Name The given name of the client. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:c:surname Surname The surname of the client. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.

Employer profile

TypeCode: E

An employer profile is a profile that represents a user's relationship with an employer. This profile type is used to indicate which employer a user is interacting with. Employers primarily have access to Zywave's LMS.

Claims

All claims for this claim type are under the namespace urn:zywave:profile:e.

Expand to view claims
Claim Name Description
urn:zywave:profile:e:employerId Employer Id The ID of the employer that the user is associated with.
urn:zywave:profile:e:employeeId Employee Id The ID of the employee that the user is associated with. Note: This is NOT the same ID as the profile.
urn:zywave:profile:e::emailAddress Email Address The email address of the employer. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:e:givenName Given Name The given name of the employer. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:e:surname Surname The surname of the employer. Note: Where possible, defer to Zywave's Identity Provider for user identity claims.
urn:zywave:profile:e:employerName Employer Name The name of the employer.
urn:zywave:profile:e:employerCity Employer City The city of the employer.
urn:zywave:profile:e:employerState Employer State The state of the employer.
urn:zywave:profile:e:isAdmin Is Administrator Indicates whether or not the user is an administrator for the employer.

Specification