A Complete Index to the Janrain REST APIs

This page lists all the Janrain API endpoints.



 
Configuration APIS Methods
/config/{app}/entityTypes
Returns information about the entity types associated with an application.
GET
/config/{app}/entityTypes/{entity_type}
Returns information about a specific entity type.
GET
/config/{app}/entityTypes/{entity_type}/attributes
Returns information about all the attributes associated with an entity type.
GET
/config/{app}/entityType/{entity_type}/attributes/{attribute_name}
Returns detailed information about a specific entity type attribute.
GET
/config/{app}/flows
Returns information about your available flows.
GET
/config/{app}/flows/{flow}
The GET method returns information about the specified flow. The PUT method updates or replaces userData objects or entityTypes referenced in the flow.
GET-PUT
/config/{app}/flows/{flow}/copy
Creates a copy of the specified flow.
POST
/config/{app}/flows/{flow}/fields
The GET method returns a list of all the fields defined in the specified flow, while the POST method provides a way to add a field to a flow.
GET - POST
/config/{app}/flows/{flow}/fields/{field}
The GET method returns information about the specified field (as found in the specified flow). The PUT method enables you to update or replace that field, while the DELETE method removes the field from the flow and from any forms that reference that field.
GET - PUT - DELETE
/config/{app}/flows/{flow}/forms
Returns information about the forms referenced within a flow.
GET
/config/{app}/flows/{flow}/forms/{form}
The GET method returns information about all the fields used in the specified form. The PUT method provides a way to update or replace any of those fields.
GET - PUT
/config/{app}/flows/{flow}/locales
Returns information about the available locales.
GET
/config/{app}/flows/{flow}/locales/{locale}
Returns the available information about the specified locale.
GET
/config/{app}/flows/{flow}/locales/{locale}/fields
The GET method returns information about the fields referenced in the specified flow. The POST method lets you add a field to the flow, and to use translatable values when doing so.
GET - POST
/config/{app}/flows/{flow}/locales/{locale}/fields/{field}
The GET method returns a field definition from the specified flow, translated into the locale language. The PUT method enables you to update/replace a field in the flow.
GET - PUT
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates
Returns a list of all the email templates found in the specified flow (and the specified locale).
GET
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}
The GET method returns information about the specified email template, while the PUT method enables you to update that template.
GET - PUT
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body
The GET method returns the body text (or HTML) for the specified email template, while the PUT method provides a way to update that body text.
GET - PUT
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject
The GET method returns the Subject line for the specified email template. The PUT method is used to modify the Subject line.
GET - PUT
/config/{app}/flows/{flow}/locales/{locale}/strings
The GET method returns all the string defined in the specified flow. The POST method enables you to add an additional string to the flow.
GET - POST
/config/{app}/flows/{flow}/locales/{locale}/strings/{string}
The GET method returns the specified string from the specified flow. The PUT method enables you to update or replace that string, while the DELETE method provides a way to delete the string altogether.
GET - PUT - DELETE
/config/{app}/flows/{flow}/promote
Copies a flow to another application.
POST
/config/{app}/flows/{flow}/screens
Returns information about all the screens associated with a flow.
GET
/config/{app}/flows/{flow}/screens/{screen}
The GET method returns basic information about the specified screen, while the PUT method lets you set the "modality" of that screen. (If modal is set to TRUE, that means the user must interact with the screen before he or she can do anything else related to Janrain registration.)
GET - PUT
/config/{app}/flows/{flow}/strings
The GET method returns information about all the string found in the specified flow. The POST method enables you to add a string to the flow.
GET - POST
/config/{app}/flows/{flow}/strings/{string}
The GET method returns information about the specified string. The PUT method provides a way to update or replace that string, and the DELETE method is used to remove that string from the flow.
GET - PUT - DELETE
/config/{app}/flows/{flow}/translations
The GET method returns information about all the translations in the specified flow, and the PATCH method enables you to update any of the translations. You use the POST method to create new translations.
GET - PATCH - POST
/config/{app}/flows/{flow}/translations/{key}
The GET method returns all the translations associated with the specified key, while the DELETE method lets you delete a translation string. Note that strings cannot be deleted in if a translation key is currently in use.
GET - DELETE
/config/{app}/flows/{flow}/versions
Returns information, including change notes, for all versions of the specified flow.
GET
/config/{app}/flows/{flow}/versions/{version}
The GET method returns information about the specified version of a flow. The POST method lets you restore a flow to one of its previous versions.
GET - POST
Entity and EntityType APIs
/entity
Returns the entity attributes (user profile values) for the specified user.
GET
/entity.bulkCreate
Creates multiple user profiles in the specified entityType (user database).
POST
/entity.count
Returns the number of records in an entityType that meet the specified criteria (for example, the number of users who specified male as their preferred gender).
GET
/entity.create
Creates a new user profile.
POST
/entity.delete
Deletes the specified user profile.
POST
/entity.deleteAccess
Invalidates the current session for the specified user. This is done by permanently removing all access tokens, refresh tokens, and refresh secrets associated with the user account. This forces the user to log on again before he or she can do anything else.
POST
/entity.find
Returns information for all the user  accounts that meet the specified criteria (for example, all the users who live in Portland, OR),
GET
/entity.replace
Replaces attribute values in a user profile. Note that attribute values not specified in your call will be set to NULL. For example, if you do not specify the user's phone number the existing phone number will be deleted and the phone number attribute set to NULL.
POST
/entity.update
Updates the specified value (or values) in a user profile (e.g., changing a user's phone number or street address). Note that attributes not specified in your call will be left as-is; only the attributes specified in the call are modified.
POST
/entityType
Returns information about the specified entityType (user database).
GET
/entityType.addAttribute
Adds a new attribute (database field) to an entityType.
POST
/entityType.addRule
Adds a new data validation rule to an entityType.
POST
/entityType.create
Creates a new entityType.
POST
/entityType.deleteAccessSchema
Deletes the specified access schemas. Access schemas determine the entityType attributes that a property (API client) has read or write access to. If the access schema is deleted, the specified client will have full read or write access to all the attributes in the entityType.
POST
/entityType.getAccessSchema
Retrieves the specified access schema. Access schemas determine the entityType attributes than a property (API client) has read or write access to.
GET
/entityType.list
Returns information about all the available entityTypes.
GET
/entityType.removeAttribute
Removes an attribute (database field) from an entityType.
POST
/entityType.removeRule
Removes the specified validation rule from an entityType.
POST
/entityType.rules
Returns all the validation rules associated with an entityType.
GET
/entityType.setAccessSchema
Assigns a new access schema to a property (API) client. Access schemas determine the entityType attributes that a property  has read or write access to. Each API client can have one read access schema and one write access schema per entityType.
POST
/entityType.setAttributeConstraints
Assigns one or more constraints to an attribute. For example, if all users must have a phone number and if those phone numbers must be unique, you would assign the phone number attribute the required and the unique restraints.
POST
Authentication API
/access/getAccessToken
Retrieves an access token.
GET
/access/getAuthorizationCode
Retrieves an authorization code that can then be traded for an access token and a refresh token.
GET
/access/getCreationToken
Retrieves a creation token, which can be used to create user profiles. Typically used by mobile developers.
GET
/access/getVerificationCode
Gets a verification code that can be used to set a timestamp in a user profile (for example, to record the date and time when an email address was verified).
GET
/access/useVerificationCode
Uses a verification code (see above) to set a timestamp in a user profile. A given verification code can only be used once.
GET
/oauth/auth_native
Completes social login authentication after a social login token has been retrieved.
POST
/oauth/auth_native_traditional
Completes a traditional login (i.e., a login that employs a username and password).
POST
/oauth/forgot_password_native
Sends a "reset password" email and link to the specified user.
POST
/oauth/link_account_native
Links a new social identity (e.g., a Facebook or Twitter account) to an existing user account.
POST
/oauth/register_native
Complete social registration. Note that you must call /oauth/auth_native before calling /oauth/register_native. If not, you command will fail with an "invalid Social Login token" error.
POST
/oauth/register_native_traditional
Completes a traditional registration. Traditional registrations employ a username and password.
POST
/oauth/token
Exchanges an authorization token or a refresh token for an access token. This access token will be accompanied by a new refresh token: when the access expires you can exchange the refresh token for another access token.
GET
/oauth/unlink_account_native
"Unlinks" a social provider from a user account. For example, if you unlink Facebook from a user account the affected user will no longer be able to logon using Facebook. Instead, they will have to log on using a username and password, or a different social provider.
POST
/oauth/update_profile_native
Updates data in a user profile.
POST
/oauth/verify_email_native
Sends a "verify email address" and link to the specified user.
POST
Advanced Policy Manager API
/governance-engine
Requests an Advanced Policy Manager policy decision.
POST
Social API
/add_domain_patterns
Adds a domain to an application's domains whitelist.
POST
/add_or_update_access_token
Adds or updates an access token being used with one of the following social login identity providers: Facebook; Renren; SoundCloud; Foursquare.
POST
/auth_info
Authenticates a social login.
POST
/get_app_settings
Returns application settings and information.
POST
/get_available_properties
Returns all the social login providers configured for an application.
POST
/get_backplane_properties
Returns information about the Backplane server, which facilitates communication between Janrain software components. This call will not return information unless you have implemented Backplane.
POST
/get_contacts
Returns all the social media contacts for the specified user account. Note that not all social login providers support this call. Those that don't will not return contact information.
POST
/get_domain_patterns
Returns information about all the domains on an application's domains whitelist.
POST
/get_share_count
Returns the number of times that a specified URL has been shared.
POST
/get_share_providers
Returns information about all the email and sharing providers configured for an application.
POST
/map
Associates a primary key with a user's social identity.
POST
/mappings
Returns all the stored identity providers associated with the specified user's primary key.
POST
/providers
Returns information about all the social login identity providers configured for an application.
POST
/set_app_settings
Configures property settings for an application.
POST
/set_auth_providers
Defines the social login identity providers assigned to an application.
POST
/set_backplane_properties
Configures property values for the Backplane server.
POST
/set_domain_patterns
Replaces the existing set of domains on an application's domains whitelist with a new set of domains.
POST
/set_share_providers
Replaces the existing set of share providers for an application with a new set of providers.
POST
/sharing/broadcast
Shares activity information with a social login identity provider.
POST
/sharing/direct
Shares activity information directly with the specified recipients on a social login provider's network.
POST
/signin/oauth_token
Exchanges a social login OAuth token for a Janrain social login token. This endpoint is used if you are authenticating users directly with a social login provider instead of using a Janrain Social Login application.
POST
/unmap
Removes an identity provider from a primary key.
POST
Partner API
/admin/add
Adds an administrator to a relying party.
POST
/admin/delete
Removes an administrator for a relying party.
POST
/admin/get
Returns information about all the administrators assigned to a relying party.
POST
/app/add_domain
Adds a domain to a Social Login application.
POST
/app/create
Creates a new Social Login application.
POST
/app/create_invite
Sends an email to a user, inviting them to become an administrator on an existing Social Login application.
POST
/app/delete
Deletes an existing Social Login application.
POST
/app/get_pending_invites
This endpoint has been deprecated and should no longer be used. Instead, use the /admin/get endpoint.
POST
/app/get_properties
Returns property values for the specified Social Login application.
POST
/app/get_provider_permissions
Returns permissions for the specified Social Login application and the specified identity provider.
POST
/app/reset_api_key
Resets the API key for a Social Login application.
POST
/app/set_properties
Configures property values for the specified Social Login application.
POST
/app/set_provider_permissions
Sets permissions for the specified Social Login application and the specified identity provider. Note that you must specify all the permissions each time you call this endpoint; that's because each new set of permissions entirely replaces the existing set of permissions. For example, suppose an app has permissions A, B, and C. If you make a new call specifying only permission D, permissions A, B, and C will be deleted, and the only permission left will be permission D.
POST
/app/verify_domain
Automates the domain verification process. At this time, this endpoint can only be used with Google and Yahoo!
POST
/apps
Lists all the Social Login applications managed by the specified partner.
POST
Clients and Settings API
/config/{app_id}/clients/{client_id}/secret
Resets the secret for an API client. Resetting the secret is equivalent to changing the client password.
PUT
/config/{app_id}/clients/{client_id}/settings
The GET method returns setting values for the specified API client, while the PUT method enables you to change client settings.
GET - PUT
/config/{app_id}/clients/{client_id}
The GET method returns permission and metadata information for an API client, while the PUT method provides a way to update the permissions and settings assigned to a client. Meanwhile, the DELETE method enables you to delete an API client.
GET - PUT-DELETE
/config/{app_id}/clients
The GET method returns permission and metadata information for all your API clients. The POST method provides a way to create a new API client.
GET - POST
/config/{app_id}/entityTypes/{entity_type}/attributes/{attribute_name}
Returns information about the specified user profile attribute.
GET
/config/{app_id}/entityTypes/{entity_type}/attributes
Returns information about all the attributes associated with the specified entityType.
GET
/config/{app_id}/entityTypes/{entity_type}
Returns information about the specified entityType.
GET
/config/{app}/entityTypes
Returns information about all your entityTypes.
GET
/config/{app_id}/settings/options
The GET method returns information about the values and settings applied at the application (global) scope. The PUT method provides a way to modify those values and settings.
GET - PUT
/config/{app_id}/settings
Returns information about the settings that can be applied to an API client.
GET
Legacy Clients and Settings API
/clients/add
Creates a new API client (property). API clients are used to manage access to the Janrain APIs.
POST
/clients/clear_whitelist
Clears the IP whitelist for an API client. When a whitelist is cleared, any device, regardless of IP address, can use the client to make API calls.
POST
/clients/delete
Deletes an API client.
POST
/clients/list
Returns a list of all the API clients associated with an application.
GET
/clients/reset_secret
Resets an API client secret. Resetting a client secret is equivalent to chaging the client password.
POST
/clients/set_description
Renames an API client.
POST
/clients/set_features
Assigns the features for an API client. Features specify the access permissions for a client; for example, a client with the access_issuer feature is allowed to issue access tokens for other clients.
POST
/clients/set_whitelist
Configures the IP whitelist for an API client. When the whitelist is configured, only devices with an IP address included on the whitelist can use the client to make API calls.
POST
/settings/delete
Removes the specified setting from a specific API client.
POST
/settings/delete_default
Removes the specified key from a specific application. This endpoint removes global keys without affecting local keys configured on individual API clients.
POST
/settings/get
Returns the value of the specified setting from an API client.
GET
/settings/get_default
Returns the value of the specified global setting from an application.
GET
/settings/get_multi
Returns multiple setting values from an API client.
GET
/settings/items
Returns all the setting values for an API client.
GET
/settings/keys
Returns the names of all the settings (but not the values configured for those settings) for an API client.
GET
/settings/set
Configures the specified setting for an API client.
POST
/settings/set_default
Configures an application setting.
POST
/settings/set_default_multi
Configures multiple application settings.
POST
/settings/set_multi
Configures multiple API client settings.
POST
/settings/widget/delete
Deletes all the published settings for an API client.
POST
/settings/widget/get
Returns the published settings for an API client.
POST
/settings/widget/list
Returns the published settings for an application.
POST
/settings/widget/publish
Publishes API client settings to a JSON file, making these settings available for client-side use with the Registration UI. This enables these settings to be loaded prior to any server-side calls. 
POST
GET