EDUCATION CENTER
Refine
Technical Library
OpenID Connect and OAuth2
Console
Webhooks v3
Customer Insights
Data Migration
Social Login
Registration
REST API
Security and Support
Identity Cloud Studios
Table of Contents
Table of Contents
Toggle navigation
Refine
Technical Library
OpenID Connect and OAuth2
Console
Webhooks v3
Customer Insights
Data Migration
Social Login
Registration
REST API
Security and Support
Identity Cloud Studios
Contact Us
Refine
Technical Library
OpenID Connect and OAuth2
Console
Webhooks v3
Customer Insights
Data Migration
Social Login
Registration
REST API
Security and Support
Identity Cloud Studios
Home
Glossary
Technical Library
OpenID Connect and OAuth2
An Introduction to OpenID Connect
OpenID Connect Technical Details
The OpenID Connect Discovery Document
JSON Web Keys
OpenID Connect Token Reference
OpenID Connect Scopes and Claims
Converting Unix Epoch Time
Configuring OpenID Connect
API Security for Configuration
OIDC Configuration API Reference
/{customer_id}/config/clients
/{customer_id}/config/clients/{client_id}
/{customer_id}/config/clients/{client_id}/secret
/{customer_id}/config/loginPolicies
/{customer_id}/config/loginPolicies//{login_policy_id}
/{customer_id}/config/tokenPolicies
/{customer_id}/config/tokenPolicies/{token_policy_id}
/{customer_id}/login/token
App Integration Guide
Authorization Code for Web Apps
Authorization Code + PKCE for Mobile Apps
Integrating OIDC Apps with the Identity Cloud
OAuth and OIDC API Reference
OAuth Token APIs
OpenID Connect APIs
User Experience
Hosted Login
Supported Features
End-User Screens
Hosted Login Configuration
Hosted Login Quick Start Provisioning Guide
Configuring Social Login
API Clients and Client Settings
Authorization Rules
Theming
CSS Reference
Default Stylesheet
body
h1, h2, h3, h4, h5, h6, p, a, span
h1, h2, h3
p
a
button
#logo
#main-container
#floating-container
#header-container
#content-container
.footer-container
.auth-screen, .auth-success-screen
#social-login-buttons
.form-action-buttons
.profile-management-card
.profile-management-row
.card-body
.card-heading
.profile-header > div
.screen-heading
.manage-screen
.auth-success-screen
.success-check
.button-danger
.action-card
button-secondary
CSS Class Reference
CSS Practice Templates
Hosted Login Screens Reference
The Hosted Login Screens Reference
The authRule_acceptLegal Screen
The authRule_consents Screen
The authRule_reqAttrs Screen
The deleteAccountSuccess Screen
The loginSuccess Screen
The logoutSuccess Screen
The manageProfile Screen
The manageProfile_data Screen
The manageProfile_privacy Screen
The manageProfile_security Screen
The mergeAccounts Screen
The profileSaveSuccess Screen
The registrationSuccess Screen
The requestDataSuccess Screen
The resendVerificationSuccess Screen
The resetPassword Screen
The resetPasswordCodeExchange Screen
The resetPasswordRequest Screen
The resetPasswordRequestSuccess Screen
The resetPasswordSuccess Screen
The signIn Screen
The socialRegistration Screen
The traditionalAuthenticateMerge Screen
The traditionalRegistration Screen
The verifyEmail Screen
The verifyEmailSuccess Screen
The visitingMessage Screen
Hosted Login How-Tos
How to Modify the Text of Your Hosted Login Screens
How to Localize the Text of Your Hosted Login Screens
Console
Console User Guide
The Console Annotated Photo Album
An Overview of the Console
Accessing the Console
Configuring Customer Care Portal Settings
Comparing the Capture Dashboard and the Console
Managing Agents
Managing Agents
Accessing the Manage Agents Page
Console Roles and Permissions
Console Roles and Capture Dashboard Permissions
Console Roles
Profile Access Filters
Restricting Agent Activity By Profile Type
Agent Groups
Configuring Agent Groups and Assigning Group Membership
Creating a New Agent
Accepting an Agent Invitation and Managing Your Console Password
Changing Your Console Password
Console Passwords vs. Dashboard Passwords
Blocking Access for an Agent
Assigning Multiple Roles to an Agent
Deleting an Agent
Filtering for Agents
Exporting Agent Data
Managing User Profiles
Managing User Profiles
Viewing Profiles on the Manage Profiles Page
Creating a User Profile
Working with the Property Attribute
Managing the Full User Record
Resending Verification Emails
Resetting a User Password
Deleting a User Profile
Exporting Audit Data
Exporting Profile Information
Searching for User Profiles
Console Search Fundamentals
Searching for and Exporting User Profiles
What You Can Search On
Modifying the Search Display Attributes
Suppressing Default Searches and "Empty" Searches
Writing a Search Query
Search Construction and Syntax
Mandatory Parts of a Search Query
Attribute Names
Operators
Target Search Values
Searching for String or Numeric Values
Searching for Datetime Values
Searching for Null Values
Writing Advanced Search Queries
Optional Parts of a Search Query
Searching with Wildcard Characters
Searching with the Boolean Operators AND and OR
Running Your Search Queries
Running Basic Searches: Default and Custom Options
Writing Search Queries Using Guided Search
Searches vs. Filters
Writing Search Queries by Using Guided Search
Search History and Search Filters
Search History and Search Filters
A Few Quick Notes About the Console Search History
Using the Search History
Saving Filters
Deleting a Saved Filter
Modifying or Renaming a Filter
Managing Schemas
An Introduction to Managing Schemas
Accessing the Manage Schemas Page
Viewing Schema Information
Exporting a Schema
Managing Applications
Managing Applications
Viewing Application Information
Managing Global Settings
Viewing Global Settings
Modifying Global Settings
Adding a New Setting
Removing a Global Setting
Accessing Property Settings
Managing Properties
Managing Properties
Searching for (and Filtering) Properties
Copying a Property
Creating a Property
Working with Features
Working with IP Whitelists
Working with Client IDs and Client Secrets
Renaming a Property
Resetting Client Secrets
Viewing Client Secrets
Deleting a Property
Managing Property Settings
Modifying Property Settings
Adding a Property Setting
Removing a Property Setting
Registration Builder
An Introduction to Registration Builder
Accessing Registration Builder
Registration Builder Permissions
Navigating Between Tabs
Managing Flows
The Registration Flows Page
Searching for Flows
Flow Actions
Editing a Flow
Copying a Flow
Restoring a Flow
Copying a Flow from the Registration Flows Page
Promoting a Flow to a Different Application
Deleting a Flow
Managing Fields
Creating a Field
Working with Advanced Options
Registration Builder Advanced Options
Configuring select and radio Options
Adding Data Validations
Blacklisted Words
Blacklisted Email Domains
Format
Match
Maximum Length
Minimum Length
Required
Unique
Whitelist Words
Client Function Name
Custom Client Setting
Copying a Field
Deleting a Field
Managing Forms
Creating a Form
Editing a Form
Example Usage
Copying a Form
Deleting a Form
Managing Screens
Creating a Screen
Copying a Screen
Editing a Screen
Deleting a Screen
Audit Logs
Console Audit Logs
Audit Logs Terminology
Accessing the Console Audit Logs
Console User Audit Logs and Profile Change Audit Data Permissions
The Audit Logs Tab in the Manage Agents Section
Searching/Filtering the Console Audit Logs
Using the Search Logs Field
Using the Audit Logs Search Filters
Combining the Search Logs Field and the Search Filters
Clearing Search Filters
Viewing Audit Log Search Results
Exporting Audit Log Search Results
Appendix A: Activity Reference
Exporting Settings
Exporting Global and Property Settings
Exporting Global Settings
Exporting Settings for a Selected Set of Properties
Frequently-Asked Questions About the Console
Frequently-Asked Questions About the Console
General Management Questions
FAQ: Searching for User Profiles
Exporting User Data
FAQ: Managing Agents
A Complete Index to Console Resources
Webhooks v3
Webhooks v3 Overview
An Introduction to Webhooks v3
Do I Even Need Webhooks v3?
A Webhooks v3 Glossary
Webhook Events
What’s the Difference Between Webhooks v2 and Webhooks v3?
Migrating from Webhooks v2 to Webhooks v3
How Webhooks Work
The Event Notification Process
How Frequently are Events Delivered?
What Happens if a Webhook Notification Can’t Be Delivered?
What If None of My Webhook Notifications Can Be Delivered?
The Anatomy of a Webhook Notification
The HTTP Post Request
HTTP Headers
Security Event Tokens
Security Event Token Headers
Security Event Token Payloads
Security Event Token Signatures
JSON Web Keys
Webhook Listener Endpoints
Configuring Listener Endpoints
Whitelisting Webhook Server IP Addresses
Working with the Webhook APIs
An Overview of the Webhooks API
Getting an Authentication Token
Using an Authentication Token to Make a Webhooks API Call
Enabling, Disabling, and Deleting Webhook Subscriptions
Configuring Webhook Subscriptions
Working with the Events Store
Customer Insights
Customer Insights Overview
Customer Insights Overview
Logging on to Customer Insights
What Happens if You Forget Your Password?
Customer Insights Event Types
Customer Insights Access Levels
Customer Insights Terminology
Finding Information in Customer Insights
Finding Information in Customer Insights
The Customer Insights Home Page
The Browse Menu
Favorites
Recently Viewed
Popular
Shared
Personal Folder
People
The Folders Menu
Using the Global Search Filter
Tile View vs. List View
Viewing Information in Customer Insights
Viewing Information in Customer Insights
Look and Dashboard Status Bars and Toolbars
Look Options
Dashboard Options
Filters
Working with Visualizations
Working with Data
Viewing Daily Profiles Counts and Daily Profiles Changes
Scheduling, Saving, and Sending Data
Scheduling, Saving, and Sending Data
Scheduling Data Delivery
Downloading Data
Sending Data
Creating Conditional Alerts
Creating Looks (and Working with Explores)
Creating Looks (and Working with Explores)
Directory-Derived Data vs. Event-Derived Data
Adding Attributes to Customer Insights
The Explore Options Icon
Adding Dimensions
Adding Measures
Adding Filters
Adding Pivots
Adding Row and Column Totals
Adding Table Calculations
Modifying Row and Column Limits
Selecting a Visualization
Creating a Dashboard
Creating a Dashboard
Creating and Naming a Dashboard
Adding Tiles to a Dashboard
Adding a Query Tile to a Dashboard
Adding a Look Tile to a Dashboard
Adding Notes to a Query Tile or a Look Tile
Editing a Query Tile or a Look Tile
Adding a Text Tile to a Dashboard
Using Markdown to Format Text Tiles
Moving and Resizing Tiles
Dashboard Filters
Adding a Filter to a Dashboard
Requiring a Filter to Run a Dashboard
Limiting Filters to a Single Clause
Linking Filters
Configuring Dashboard Settings
Filter Operators Reference
Filter Operators Reference
Null Values vs. Blank Values
Customer Insights Explore Reference
The Customer Insights Explore Reference
App Dim
Client Dims
Date Dims
Event Fact
Idp Dim
Location Dim
Profile Dim
Profile Fact
Time Dim
User Agent Dim
Customer Insights Visualization Reference
Table Visualization
Column
Bar
Scatterplot
Line
Area
Pie
Map
Single Value
Funnel
Timeline
Static Map (Regions)
Static Map (Points)
Donut Multiples
Single Record
Customer Insights Dashboards
Dashboards -- Customer Insights
A Complete Index to Customer Insights Resources
Data Migration
Standard Profile Data Migration Services
Custom Data Migration Services
Data Mapping and Transformation
Self-Service Data Migration
Akamai Identity Cloud Data Migration
What is Data Migration?
Step 1: Downloading the Required Files
Step 2: Configuring and Verifying System Requirements
Step 3: Mapping Your Legacy Data to an Identity Cloud User Profile Schema
Step 4: Creating the Data Migration Datafile
Step 5: Creating Data Transformations
Transforming Passwords
Transforming Plurals
Working with Data Transformations
Data Transformations vs. Data Validations
Step 6: Running dataload.py
Using the Dry Run Option
How Long Will It Take for Dataload to Complete?
Delta Migrations
Retry CSV
Data Migration Log Files
Social Login
Identity Providers
Social Login Overview
Amazon Social Login Configuration Guide
Apple Configuration Guide
DocCheck Social Login Configuration Guide
Doximity Social Login Configuration Guide
Facebook Social Login Configuration Guide
Fimnet Social Login Configuration Guide
Flickr Social Login Configuration Guide
Foursquare Social Login Configuration Guide
Google Social Login Configuration Guide
Instagram Social Login Configuration Guide
LINE Social Login Configuration Guide
LinkedIn OAuth 2.0 Configuration Guide
LiveJournal Social Login Configuration Guide
MediKey Social Login Configuration Guide
Medy Social Login Configuration Guide
Microsoft Account Social Login Configuration Guide
Microsoft Active Directory Federation Services
Microsoft Azure Social Login Configuration Guide
Mixi Social Login Configuration Guide
Odnoklassniki Social Login Configuration Guide
Okta Configuration Guide
OneKey Social Login Configuration Guide
PayPal Social Login Configuration Guide
Ping Configuration Guide
QQ Social Login Configuration Guide
RenRen Social Login Configuration Guide
Salesforce Social Login Configuration Guide
Sina Weibo Social Login Configuration Guide
Snapchat Social Login Configuration Guide
swiss-rx-login social Login Configuration Guide
Twitter Social Login Configuration Guide
VK Social Login Configuration Guide
VMware Identity Manager
WeChat Social Login Configuration Guide
Yahoo! Social Login Configuration Guide
Yahoo! OAuth 2.0 Social Login Configuration Guide
User Profile Data by Provider
get_contacts Overview
Implementing Social Login
Social Login Overview
Implementing Social Login
Single Sign-On with Social Login
Customizing Social Login
Customizing Social Login
Retrieving User Data
Customizing Your Application Domain
Customizing the Appearance of the Social Login UI
Implementing Third-Party Analytics
Assigning Scopes on a Per-Page Basis
Progressive Permissioning for Facebook
Logging Users Out of Facebook
Adding a Custom Provider Button
Account Mapping
Social Login JavaScript API
Social Login JavaScript API
Social Login JavaScript API: Events
Social Login JavaScript API: Functions
Social Login JavaScript API: Settings
Social Login JavaScript API: Cookies
Social Login Analytics
Social Login Analytics
Overview Page
Users Reports
Interactions Reports
Providers Reports
Social Sharing
Social Sharing Overview
Implementing Social Sharing
Sharing Support by Provider
Sharing Count
Social Sharing JavaScript API
Social Sharing JavaScript API: Global Settings
Social Sharing JavaScript API: Instance Settings
Social Sharing JavaScript API: Social Sharing Events
Social Sharing JavaScript API: Social Sharing Functions
A Complete Index to Social Login Resources
Registration
Registration Overview
Registration Overview
Registration Components
Access Tokens and Code
Registration Dashboard
Implementing Registration
Deployment Overview
The Reference Implementation
Configuration Acceptance Testing
Step-by-Step Implementation Process
Production Launch Process
Flow Versioning
Managing Sessions with Registration
API-Based Implementation Guide
API-Based Implementation
Traditional Login and Registration
Social Login and Registration
Account Merge
Account Link/Unlink
Email Verification
Forgot Password
Profile Update
Exchange Authorization Code
Default Registration Experience
Default Registration Experience
Screens Overview
Emails Overview
Screens
Emails
API Clients and Settings
API Clients and Permissions
API Client Settings
Managing API Clients and Settings
Customizing Registration
Customizing the Registration Experience
Customizing the Information Gathered During Registration
Customizing the Flow of the User Experience
Customizing Validation and Other Logic
Customizing the Style and Aesthetics of Your Forms
Customizing Transactional Emails
Customizing Languages and Locales
Managing Multiple Sites and Brands
Data Management
Data and Access Management Overview
Managing Your Schema
Managing User Data
Webhooks
Single Sign-On
Single Sign-On Overview
Single Sign-On for the Registration UI
Single Sign-On for the Registration APIs
Registration JavaScript API
Registration JavaScript API
Registration JavaScript API: Events
Registration JavaScript API: Settings
Registration JavaScript API: Functions
A Complete Index to Registration Resources
Registration Security Best Practices
REST API
Configuration API
Configuration API: Clients and Settings
Clients and Settings API Overview
/config/{app_id}/clients
/config/{app_id}/clients/{client_id}
/config/{app_id}/clients/{client_id}/secret
/config/{app_id}/clients/{client_id}/settings
/config/{app_id}/settings
/config/{app_id}/settings/options
Configuration API: EntityType
/config/{app_id}/entityTypes
/config/{app_id}/entityTypes/{entity_type}
/config/{app_id}/entityTypes/{entity_type}/attributes
/config/{app_id}/entityTypes/{entity_type}/attributes/{attribute_name}
Configuration API: Flows
Janrain Configuration API
Configuration API: Adding and Updating Fields
Configuration API: Modifying Forms
/config/{app}/flows
/config/{app}/flows/{flow}
/config/{app}/flows/{flow}/copy
/config/{app}/flows/{flow}/fields
/config/{app}/flows/{flow}/fields/{field}
/config/{app}/flows/{flow}/forms
/config/{app}/flows/{flow}/forms/{form}
/config/{app}/flows/{flow}/links
/config/{app}/flows/{flow}/links/{link}
/config/{app}/flows/{flow}/locales
/config/{app}/flows/{flow}/locales/{locale}
/config/{app}/flows/{flow}/locales/{locale}/fields
/config/{app}/flows/{flow}/locales/{locale}/fields/{field}
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject
/config/{app}/flows/{flow}/locales/{locale}/strings
/config/{app}/flows/{flow}/locales/{locale}/strings/{string}
/config/{app}/flows/{flow}/promote
/config/{app}/flows/{flow}/screens
/config/{app}/flows/{flow}/screens/{screen}
/config/{app}/flows/{flow}/strings
/config/{app}/flows/{flow}/strings/{string}
/config/{app}/flows/{flow}/translations
/config/{app}/flows/{flow}/translations/{key}
/config/{app}/flows/{flow}/versions
/config/{app}/flows/{flow}/versions/{version}
Entity and EntityType APIs
Janrain Entity API
Entity API: Security Schemes
/entity
/entity.bulkCreate
/entity.count
/entity.create
/entity.delete
/entity.deleteAccess
/entity.find
/entity.replace
/entity.update
/entityType
/entityType.addAttribute
/entityType.addRule
/entityType.create
/entityType.deleteAccessSchema
/entityType.getAccessSchema
/entityType.list
/entityType.removeAttribute
/entityType.removeRule
/entityType.rules
/entityType.setAccessSchema
/entityType.setAttributeConstraints
Authentication API
Authentication API Overview
Authentication API: Security Schemes
/access/getAccessToken
/access/getAuthorizationCode
/access/getVerificationCode
/access/useVerificationCode
/oauth/auth_native
/oauth/auth_native_traditional
/oauth/forgot_password_native
/oauth/link_account_native
/oauth/register_native
/oauth/register_native_traditional
/oauth/token
/oauth/unlink_account_native
/oauth/update_profile_native
/oauth/verify_email_native
Webhooks v3
/{customerId}/webhooks/subscriptions/{subscriptionId}/events
/{customerId}/webhooks/subscriptions/{subscriptionId}/events/redeliver
/{customerId}/webhooks/subscriptions/{subscriptionId}/events/{eventId}
/{customerId}/webhooks/subscriptions/{subscriptionId}/events/{eventId}/history
/{customerId}/webhooks/subscriptions/{subscriptionId}/events/{eventId}/redeliver
/{customerId}/webhooks/subscriptions
/{customerId}/webhooks/subscriptions/{subscriptionId}
/{customerId}/webhooks/subscriptions/{subscriptionId}/test
Social API
Social Login API Overview
Social Login Error Codes
/add_domain_patterns
/add_or_update_access_token
/auth_info
/get_app_settings
/get_available_properties
/get_backplane_properties
/get_contacts
/get_domain_patterns
/get_share_count
/get_share_providers
/map
/providers
/set_app_settings
/set_auth_providers
/set_backplane_properties
/set_domain_patterns
/set_share_providers
/sharing/broadcast
/sharing/direct
/signin/oauth_token
/unmap
Legacy Clients and Settings API
Legacy Clients and Settings API
/clients/add
/clients/clear_whitelist
/clients/delete
/clients/list
/clients/reset_secret
/clients/set_description
/clients/set_features
/clients/set_whitelist
/settings/delete
/settings/delete_default
/settings/get
/settings/get_default
/settings/get_multi
/settings/items
/settings/keys
/settings/set
/settings/set_default
/settings/set_default_multi
/settings/set_multi
/settings/widget/delete
/settings/widget/get
/settings/widget/list
/settings/widget/publish
Error Codes
Error Codes
Response Format
A Complete Index to the REST APIs
Release Notes
New
Security and Support
Identity Cloud and GDPR Compliance
Supported Web Browsers
Identity Cloud Studios
System Demos: Identity Cloud Console
System Demos: Identity Cloud APIs
System Demos: Registration and Social Login Configuration
Home
Technical Library
OpenID Connect and OAuth2
An Introduction to OpenID Connect
OpenID Connect Technical Details
Configuring OpenID Connect
App Integration Guide
OAuth and OIDC API Reference
User Experience