Everything you need to know about API clients and how to manage them.
-
-
- An Introduction to OpenID Connect
-
- API Security for Configuration
- /{customerId}/config/clients
- /{customerId}/config/clients/{oidcClientId}
- /{customerId}/config/clients/{oidcClientId}/secret
- /{customerId}/config/loginPolicies
- /{customerId}/config/loginPolicies/{loginPolicyId}
- /{customerId}/config/tokenPolicies
- /{customerId}/config/tokenPolicies/{tokenPolicyId}
- /{customerId}/login/token
-
- Hosted Login
- Supported Features
- End-User Screens
-
- Hosted Login Quick Start Provisioning Guide
- Configuring Social Login
- Application Clients and Client Settings
- Authorization Rules
- Theming
-
- The Sign-in Screen (signIn)
- The Sign-In Successful Screen (loginSuccess)
- The Logout Successful Screen (logoutSuccess)
- The Create Account Screen (traditionalRegistration)
- The Account Created Screen (registrationSucccess)
- The Complete Social Registration Screen (socialRegistration)
- The Merge Social Account Screen (mergeAccounts)
- The Merge Traditional Account Screen (traditionalAuthenticateMerge)
- The Thank You for Visiting Screen (visitingMessage
- The Manage User Profile Screen (manageProfile)
- The Personal Data Request Screen (manageProfile_data)
- The Manage Account Security Screen (manageProfile_security)
- The Manage Privacy Settings Screen (manageProfile_privacy)
- The Personal Data Request Screen (requestDataSuccess)
- The Account Marked for Deletion Screen (deleteAccountSuccess)
- The Forgot Password Screen (resetPasswordRequest)
- The Password Reset Instructions Screen (resetPasswordRequestSuccess)
- The Reset Password Screen (resetPassword)
- The Password Has Been Changed Screen (resetPasswordSuccess)
- The Password Reset Link is Not Valid Screen (resetPasswordCodeExchange)
- The Email Verification Required Screen (resendVerificationEmailSuccess)
- The Email Has Been Verified Screen (verifyEmailSuccess)
- The Email Verification Code Not Valid Screen (verifyEmail)
- The Terms of Service Screen (authRule_acceptLegal)
- The User Consent Required Screen (authRule_consents)
- The Additional Information Required Screen (authRule_reqAttrs)
- The Email Verification Required Screen (authRule_verifyEmail)
-
- The Hosted Login Screens Reference
- Search for a Translation
- The authRule_acceptLegal Screen: Text Reference
- The authRule_consents Screen: Text Reference
- The authRule_reqAttrs Screen: Text Reference
- The deleteAccountSuccess Screen: Text Reference
- The loginSuccess Screen: Text Reference
- The logoutSuccess Screen: Text Reference
- The manageProfile Screen: Text Reference
- The manageProfile_data Screen: Text Reference
- The manageProfile_privacy Screen: Text Reference
- The manageProfile_security Screen: Text Reference
- The mergeAccounts Screen: Text Reference
- The profileSaveSuccess Screen: Text Reference
- The registrationSuccess Screen: Text Reference
- The requestDataSuccess Screen: Text Reference
- The resendVerificationSuccess Screen: Text Reference
- The resetPassword Screen: Text Reference
- The resetPasswordCodeExchange Screen: Text Reference
- The resetPasswordRequest Screen: Text Reference
- The resetPasswordRequestSuccess Screen: Text Reference
- The resetPasswordSuccess Screen: Text Reference
- The signIn Screen: Text Reference
- The socialRegistration Screen: Text Reference
- The traditionalAuthenticateMerge Screen: Text Reference
- The traditionalRegistration Screen: Text Reference
- The verifyEmail Screen: Text Reference
- The verifyEmailSuccess Screen: Text Reference
- The visitingMessage Screen: Text Reference
-
- The authRule_acceptLegal Screen: CSS
- The authRule_consents Screen: CSS
- The authRule_reqAttrs Screen: CSS
- The authRule_verifyEmail Screen: CSS
- The deleteAccountSuccess Screen: CSS
- The loginSuccess Screen: CSS
- The logoutSuccessScreen: CSS
- The manageProfile Screen: CSS
- The manageProfile_data Screen: CSS
- The manageProfile_privacy Screen: CSS
- The manageProfile_security Screen: CSS
- The mergeAccounts Screen: CSS
- The profileSaveSuccess Screen: CSS
- The registrationSuccess Screen: CSS
- The requestDataSuccess Screen: CSS
- The resendVerificationSuccess Screen: CSS
- The resetPassword Screen: CSS
- The resetPasswordCodeExchange Screen: CSS
- The resetPasswordRequest Screen: CSS
- The resetPasswordRequestSuccess Screen: CSS
- The resetPasswordSuccess Screen: CSS
- The signIn Screen: CSS
- The socialRegistration Screen: CSS
- The traditionalAuthenticateMerge Screen: CSS
- The traditionalRegistration Screen: CSS
- The verifyEmail Screen: CSS
- The verifyEmailSuccess Screen: CSS
- The visitingMessage Screen: CSS
-
- 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
-
-
- 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
-
-
- An Introduction to Managing Schemas
- Accessing the Manage Schemas Page
- Viewing Schema Information
- Exporting a Schema
-
- Managing Properties
- Searching for (and Filtering) Properties
- Copying a Property
- Creating a Property
- Working with Features
- Working with IP Allow Lists
- 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
-
- An Introduction to Registration Builder
- Accessing Registration Builder
- Registration Builder Permissions
- Navigating Between Tabs
-
- Creating a Field
- Working with Advanced Options
- Registration Builder Advanced Options
- Configuring select and radio Options
- Adding Data Validations
- Suppressed Words
- Suppressed Email Domains
- Format
- Match
- Maximum Length
- Minimum Length
- Required
- Unique
- Allowed Words
- Client Function Name
- Custom Client Setting
- Copying a Field
- Deleting a Field
-
- 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
- Appendix A: Activity Reference
-
-
- An Introduction to SIEM Event Delivery
- The General Event Delivery Service Allow List
- An Important Note Concerning Duplicate Events
- Identity Cloud Event Management and Analysis Tools
- Identity Cloud SIEM Events
- How the SIEM Event Delivery Service Works
- Provisioning SIEM Event Delivery
- Adding the Akamai Account ID to the Application
- Activating/Deactivating SIEM Delivery Feeds
- Configuring Amazon S3 Buckets and Public Keys
- Managing Public Keys
- Blocking SIEM Events
- Retrieving Data from an S3 Bucket
- Using Identity Cloud SIEM Events and SIEM Applications
-
-
- 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
-
- Standard Profile Data Migration Services
- Custom Data Migration Services
- Data Mapping and Transformation
-
- 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
-
-
- 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! Japan Social Login Configuration Guide
- Yahoo! OAuth 2.0 Social Login Configuration Guide
-
- 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
-
-
- 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
- Registration Security Best Practices
-
-
-
- Identity Cloud Configuration API
- /config/{appId}/flows
- /config/{appId}/flows/{flow}
- /config/{appId}/flows /{flow}/copy
- /config/{appId}/ flows/{flow}/fields
- /config/{appId}/flows/ {flow}/fields/{field}
- /config/{appId}/flows/ {flow}/forms
- /config/{appId}/flows/ {flow}/forms/{form}
- /config/{appId}/flows/ {flow}/links/{link}
- /config/{appId}/flows/ {flow}/links/{link}
- /config/{appId}/flows/ {flow}/locales
- /config/{appId}/flows/{flow}/ locales/{locale}/fields/{field}
- /config/{appId}/flows/{flow}/ locales/{locale}/fields/{field}
- /config/{appId}/flows/{flow}/ locales/{locale}/fields/{field}
- /config/{appId}/flows/{flow}/ locales/{locale}/mailTemplates
- /config/{appId}/flows/{flow}/ locales/{locale}/mailTemplates/ {template}
- /config/{appId}/flows/{flow}/ locales/{locale}/mailTemplates/ {template}/body
- /config/{appId}/flows/{flow}/ locales/{locale}/mailTemplates/ {template}/subject
- /config/{appId}/flows/{flow}/ locales/{locale}/strings
- /config/{appId}/flows/{flow}/ locales/{locale}/strings/{string}
- /config/{appId}/flows/ {flow}/promote
- /config/{appId}/flows /{flow}/screens
- /config/{appId}/flows/ {flow}/screens/{screen}
- /config/{appId}/ flows/{flow}/strings
- /config/{appId}/flows/ {flow}/strings/{string}
- /config/{appId}/flows/ {flow}/translations/{keyId}
- /config/{appId}/flows/ {flow}/translations/{keyId}
- /config/{appId}/flows/ {flow}/versions/{versionId}
- /config/{appId}/flows/ {flow}/versions/{versionId}
-
- Identity Cloud Entity API
- Entity API: Security Schemes
- Why Can't I Find the User Account I Just Created? New
- /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 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
-
- /{customerId}/webhooks/ subscriptions/{subscriptionId}/ events
- /{customerId}/webhooks/ subscriptions/{subscriptionId}/ events/{eventId}
- /{customerId}/webhooks/ subscriptions/{subscriptionId}/ events/{eventId}/history
- /{customerId}/webhooks/ subscriptions
- /{customerId}/webhooks/ subscriptions/{subscriptionId}
- /{customerId}/webhooks/ subscriptions/{subscriptionId}/test
-
- 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
-
-
- Release Notes
- New and Newly-Updated Updated
API Clients and Settings
Last Modified on 06/23/2020 4:07 pm PDT
Comments
Thanks!
Copyright © 2015 – 2016 Your Company, LLC. All rights reserved.