NAV
Ruby Shell

Consumer Identity Provider API v1

The HealtheIntent Consumer Identity Provider API enables single sign-on (SSO) access to the HealtheIntent Wellness and HealtheIntent Patient Portal applications.

URL: https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1

Consumer Identity Provider

The consumer identity provider is an application that allows HealtheIntent Consumer Identity Provider users to sign in, sign up, and manage their Cerner consumer account information. Consumer Identity Provider supports Security Assertion Markup Language 2.0 (SAML 2.0) profiles for authenticating users and managing user sessions. This enables SSO and single sign-out across multiple consumer applications that integrate with HealtheIntent Consumer Identity Provider as SAML 2.0 service providers.

Create a Service Provider

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers', headers: headers, body: {"name":"CareKC Wellness Portal","entityId":"https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata","metadataUrl":"https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata","singleLogoutEnabled":true,"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"CareKC Wellness Portal","entityId":"https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata","metadataUrl":"https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata","singleLogoutEnabled":true,"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"}}

Example response

{
  "id": "4645f58d-952b-4398-b9ad-7310ec4482c8",
  "name": "CareKC Wellness Portal",
  "entityId": "https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata",
  "metadataUrl": "https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata",
  "singleLogoutEnabled": true,
  "identityProvider": {
    "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
  }
}

POST /service-providers

Creates a service provider. A service provider represents the system that sends a request to the identity provider to authenticate the user and transfer the user’s identity.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postServiceProviders true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created ServiceProvider
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of Service Providers

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "4645f58d-952b-4398-b9ad-7310ec4482c8",
      "name": "CareKC Wellness Portal",
      "entityId": "https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata",
      "metadataUrl": "https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata",
      "singleLogoutEnabled": true,
      "identityProvider": {
        "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers?offset=0&limit=20"
}

GET /service-providers

Retrieves a list of service providers. A service provider represents the system that sends a request to the identity provider to authenticate the user and transfer the user’s identity.

Parameters

Parameter In Type Required Default Description Accepted Values
entityId query string false N/A Filters by the entityId of the service provider. -
identityProviderId query string false N/A Filters by the ID of the identity provider. -
id query array[string] false N/A Filters by the IDs of the service providers. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success ServiceProviders
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update a Service Provider

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers/4645f58d-952b-4398-b9ad-7310ec4482c8', headers: headers, body: {"name":"CareKC Wellness Portal","entityId":"https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata","metadataUrl":"https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata","singleLogoutEnabled":true,"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers/4645f58d-952b-4398-b9ad-7310ec4482c8 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"CareKC Wellness Portal","entityId":"https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata","metadataUrl":"https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata","singleLogoutEnabled":true,"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"}}

PUT /service-providers/{id}

Updates a service provider. A service provider represents the system that sends a request to the identity provider to authenticate the user and transfer the user’s identity.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the service provider. -
body body putServiceProviders true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content ServiceProvider
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Remove a Service Provider

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers/4645f58d-952b-4398-b9ad-7310ec4482c8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers/4645f58d-952b-4398-b9ad-7310ec4482c8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /service-providers/{id}

Removes a service provider. A service provider represents the system that sends a request to the identity provider to authenticate the user and transfer the user’s identity.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the service provider. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content ServiceProvider
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Service Provider

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers/4645f58d-952b-4398-b9ad-7310ec4482c8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/service-providers/4645f58d-952b-4398-b9ad-7310ec4482c8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "4645f58d-952b-4398-b9ad-7310ec4482c8",
  "name": "CareKC Wellness Portal",
  "entityId": "https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata",
  "metadataUrl": "https://carekc.wellness.us-1.healtheintent.com/session-api/protocol/saml2/metadata",
  "singleLogoutEnabled": true,
  "identityProvider": {
    "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
  }
}

GET /service-providers/{id}

Retrieves a single service provider. A service provider represents the system that sends a request to the identity provider to authenticate the user and transfer the user’s identity.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the service provider. -

Response Statuses

Status Meaning Description Schema
200 OK Success ServiceProvider
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

OAuth

An OAuth client represents the application that uses the OAuth 2.0 authentication workflow to request access to the protected resources.

Create an OAuth Client

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients', headers: headers, body: {"name":"Inspira App","redirectUri":"https://inspira.app.com/callback","scopes":["read","write"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Inspira App","redirectUri":"https://inspira.app.com/callback","scopes":["read","write"]}

Example response

{
  "id": "c1f39839-6453-413f-9851-15c93d881e5b",
  "name": "Inspira App",
  "redirectUri": "https://inspira.app.com/callback",
  "scopes": [
    "read",
    "write"
  ]
}

POST /oauth-clients

Creates an OAuth client. An OAuth client represents the application that requests access to the protected resources using the OAuth 2.0 standard.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postOauthClients true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created OauthClient
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of OAuth Clients

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "c1f39839-6453-413f-9851-15c93d881e5b",
      "name": "Inspira App",
      "redirectUri": "https://inspira.app.com/callback",
      "scopes": [
        "read",
        "write"
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients?offset=0&limit=20"
}

GET /oauth-clients

Retrieves a list of OAuth clients. An OAuth client represents the application that requests access to the protected resources using the OAuth 2.0 standard.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success OauthClients
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update an OAuth Client

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients/c1f39839-6453-413f-9851-15c93d881e5b', headers: headers, body: {"name":"Inspira App","redirectUri":"https://inspira.app.com/callback","scopes":["read","write"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients/c1f39839-6453-413f-9851-15c93d881e5b \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Inspira App","redirectUri":"https://inspira.app.com/callback","scopes":["read","write"]}

PUT /oauth-clients/{id}

Updates an OAuth client. An OAuth client represents the application that requests access to the protected resources using the OAuth 2.0 standard.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the OAuth client. -
body body putOauthClients true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content OauthClient
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Remove an OAuth Client

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients/c1f39839-6453-413f-9851-15c93d881e5b', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients/c1f39839-6453-413f-9851-15c93d881e5b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /oauth-clients/{id}

Removes an OAuth client. An OAuth client represents the application that requests access to the protected resources using the OAuth 2.0 standard.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the OAuth client. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content OauthClient
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single OAuth Client

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients/c1f39839-6453-413f-9851-15c93d881e5b', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/oauth-clients/c1f39839-6453-413f-9851-15c93d881e5b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "c1f39839-6453-413f-9851-15c93d881e5b",
  "name": "Inspira App",
  "redirectUri": "https://inspira.app.com/callback",
  "scopes": [
    "read",
    "write"
  ]
}

GET /oauth-clients/{id}

Retrieves a single OAuth client. An OAuth client represents the application that requests access to the protected resources using the OAuth 2.0 standard.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the OAuth client. -

Response Statuses

Status Meaning Description Schema
200 OK Success OauthClient
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Configuration

You can use the resources below to configure brands, email templates, identity providers, and site configurations for HealtheIntent Consumer Identity Provider.

Create a Brand

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands', headers: headers, body: {"name":"Care KC Default","logo":{"src":"https://img.cerner.com/logo","localizedTexts":{"locale":"en-US","text":"A text value in English."}},"backgroundImage":{"src":"https://img.cerner.com/background-image","localizedTexts":{"locale":"en-US","text":"A text value in English."}},"customFontScripts":{"async":"false","defer":"false","src":"https://example.com/custom.js","text":null,"integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"},"webAnalyticsScripts":{"async":"false","defer":"false","src":"https://example.com/custom.js","text":null,"integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Care KC Default","logo":{"src":"https://img.cerner.com/logo","localizedTexts":{"locale":"en-US","text":"A text value in English."}},"backgroundImage":{"src":"https://img.cerner.com/background-image","localizedTexts":{"locale":"en-US","text":"A text value in English."}},"customFontScripts":{"async":"false","defer":"false","src":"https://example.com/custom.js","text":null,"integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"},"webAnalyticsScripts":{"async":"false","defer":"false","src":"https://example.com/custom.js","text":null,"integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"}}

Example response

{
  "id": "edf515ac-9d19-42c2-8b6a-342ec27f49e6",
  "name": "Care KC Default",
  "logo": {
    "src": "https://img.cerner.com/logo",
    "localizedTexts": {
      "locale": "en-US",
      "text": "A text value in English."
    }
  },
  "backgroundImage": {
    "src": "https://img.cerner.com/background-image",
    "localizedTexts": {
      "locale": "en-US",
      "text": "A text value in English."
    }
  },
  "customFontScripts": {
    "async": "false",
    "defer": "false",
    "src": "https://example.com/custom.js",
    "text": null,
    "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
  },
  "webAnalyticsScripts": {
    "async": "false",
    "defer": "false",
    "src": "https://example.com/custom.js",
    "text": null,
    "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
  }
}

POST /brands

Creates a brand. A brand defines the client-customized images and styles that are displayed on a site.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postBrands true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Brand
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of Brands

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "edf515ac-9d19-42c2-8b6a-342ec27f49e6",
      "name": "Care KC Default",
      "logo": {
        "src": "https://img.cerner.com/logo",
        "localizedTexts": {
          "locale": "en-US",
          "text": "A text value in English."
        }
      },
      "backgroundImage": {
        "src": "https://img.cerner.com/background-image",
        "localizedTexts": {
          "locale": "en-US",
          "text": "A text value in English."
        }
      },
      "customFontScripts": {
        "async": "false",
        "defer": "false",
        "src": "https://example.com/custom.js",
        "text": null,
        "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
      },
      "webAnalyticsScripts": {
        "async": "false",
        "defer": "false",
        "src": "https://example.com/custom.js",
        "text": null,
        "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands?offset=0&limit=20"
}

GET /brands

Retrieves a list of brands. A brand defines the client-customized images and styles that are displayed on a site.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success Brands
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update a Brand

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands/edf515ac-9d19-42c2-8b6a-342ec27f49e6', headers: headers, body: {"name":"Care KC Default","logo":{"src":"https://img.cerner.com/logo","localizedTexts":{"locale":"en-US","text":"A text value in English."}},"backgroundImage":{"src":"https://img.cerner.com/background-image","localizedTexts":{"locale":"en-US","text":"A text value in English."}},"customFontScripts":{"async":"false","defer":"false","src":"https://example.com/custom.js","text":null,"integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"},"webAnalyticsScripts":{"async":"false","defer":"false","src":"https://example.com/custom.js","text":null,"integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands/edf515ac-9d19-42c2-8b6a-342ec27f49e6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Care KC Default","logo":{"src":"https://img.cerner.com/logo","localizedTexts":{"locale":"en-US","text":"A text value in English."}},"backgroundImage":{"src":"https://img.cerner.com/background-image","localizedTexts":{"locale":"en-US","text":"A text value in English."}},"customFontScripts":{"async":"false","defer":"false","src":"https://example.com/custom.js","text":null,"integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"},"webAnalyticsScripts":{"async":"false","defer":"false","src":"https://example.com/custom.js","text":null,"integrity":"sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"}}

PUT /brands/{id}

Updates a single brand record by ID. A brand defines the client-customized images and styles that are displayed on a site.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the brand. -
body body putBrands true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content Brand
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Remove a Brand

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands/edf515ac-9d19-42c2-8b6a-342ec27f49e6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands/edf515ac-9d19-42c2-8b6a-342ec27f49e6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /brands/{id}

Removes a single brand record by ID. A brand defines the client-customized images and styles that are displayed on a site.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the brand. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content Brand
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Brand

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands/edf515ac-9d19-42c2-8b6a-342ec27f49e6', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/brands/edf515ac-9d19-42c2-8b6a-342ec27f49e6 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "edf515ac-9d19-42c2-8b6a-342ec27f49e6",
  "name": "Care KC Default",
  "logo": {
    "src": "https://img.cerner.com/logo",
    "localizedTexts": {
      "locale": "en-US",
      "text": "A text value in English."
    }
  },
  "backgroundImage": {
    "src": "https://img.cerner.com/background-image",
    "localizedTexts": {
      "locale": "en-US",
      "text": "A text value in English."
    }
  },
  "customFontScripts": {
    "async": "false",
    "defer": "false",
    "src": "https://example.com/custom.js",
    "text": null,
    "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
  },
  "webAnalyticsScripts": {
    "async": "false",
    "defer": "false",
    "src": "https://example.com/custom.js",
    "text": null,
    "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
  }
}

GET /brands/{id}

Retrieves a single brand record by ID. A brand defines the client-customized images and styles that are displayed on a site.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the brand. -

Response Statuses

Status Meaning Description Schema
200 OK Success Brand
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Create an Email Template

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates', headers: headers, body: {"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"},"sender":{"email":"noreply@cckc.com","name":"Care KC","replyTo":"do-not-reply@cckc.com","returnPath":"carekc@cckc.com"},"subject":"Reset Password","type":"PASSWORD_RESET","emailBodies":[{"locale":"en-US","html":"<!DOCTYPE html> <html> <head> <title>Page Title</title> </head><body> <p>Hi,</p> <p>your verification code is: {{verification_code}}.</p><p>Thank you.</p> </body> </html>","text":"Hi, your verification code is: {{verification_code}}. Thank you."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"},"sender":{"email":"noreply@cckc.com","name":"Care KC","replyTo":"do-not-reply@cckc.com","returnPath":"carekc@cckc.com"},"subject":"Reset Password","type":"PASSWORD_RESET","emailBodies":[{"locale":"en-US","html":"<!DOCTYPE html> <html> <head> <title>Page Title</title> </head><body> <p>Hi,</p> <p>your verification code is: {{verification_code}}.</p><p>Thank you.</p> </body> </html>","text":"Hi, your verification code is: {{verification_code}}. Thank you."}]}

Example response

{
  "id": "e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3",
  "identityProvider": {
    "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
  },
  "sender": {
    "email": "noreply@cckc.com",
    "name": "Care KC",
    "replyTo": "do-not-reply@cckc.com",
    "returnPath": "carekc@cckc.com"
  },
  "subject": "Reset Password",
  "type": "PASSWORD_RESET",
  "emailBody": [
    {
      "locale": "en-US",
      "html": "<!DOCTYPE html> <html> <head> <title>Page Title</title> </head><body> <p>Hi,</p> <p>your verification code is: {{verification_code}}.</p><p>Thank you.</p> </body> </html>",
      "text": "Hi, your verification code is: {{verification_code}}. Thank you."
    }
  ]
}

POST /email-templates

Creates an Email Template. An email template configures email content that is sent to users.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postEmailTemplates true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created EmailTemplate
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of Email Templates

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3",
      "identityProvider": {
        "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
      },
      "sender": {
        "email": "noreply@cckc.com",
        "name": "Care KC",
        "replyTo": "do-not-reply@cckc.com",
        "returnPath": "carekc@cckc.com"
      },
      "subject": "Reset Password",
      "type": "PASSWORD_RESET",
      "emailBody": [
        {
          "locale": "en-US",
          "html": "<!DOCTYPE html> <html> <head> <title>Page Title</title> </head><body> <p>Hi,</p> <p>your verification code is: {{verification_code}}.</p><p>Thank you.</p> </body> </html>",
          "text": "Hi, your verification code is: {{verification_code}}. Thank you."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates?offset=0&limit=20"
}

GET /email-templates

Retrieves a list of email templates. An email template configures email content that is sent to users.

Parameters

Parameter In Type Required Default Description Accepted Values
identityProviderId query string false N/A Filters by the ID of the identity provider. -
emailType query string false N/A Filters by the type of the email. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success EmailTemplates
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update an Email Template

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates/e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3', headers: headers, body: {"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"},"sender":{"email":"noreply@cckc.com","name":"Care KC","replyTo":"do-not-reply@cckc.com","returnPath":"carekc@cckc.com"},"subject":"Reset Password","type":"PASSWORD_RESET","emailBodies":[{"locale":"en-US","html":"<!DOCTYPE html> <html> <head> <title>Page Title</title> </head><body> <p>Hi,</p> <p>your verification code is: {{verification_code}}.</p><p>Thank you.</p> </body> </html>","text":"Hi, your verification code is: {{verification_code}}. Thank you."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates/e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"},"sender":{"email":"noreply@cckc.com","name":"Care KC","replyTo":"do-not-reply@cckc.com","returnPath":"carekc@cckc.com"},"subject":"Reset Password","type":"PASSWORD_RESET","emailBodies":[{"locale":"en-US","html":"<!DOCTYPE html> <html> <head> <title>Page Title</title> </head><body> <p>Hi,</p> <p>your verification code is: {{verification_code}}.</p><p>Thank you.</p> </body> </html>","text":"Hi, your verification code is: {{verification_code}}. Thank you."}]}

PUT /email-templates/{id}

Updates an email template. An email template configures email content that is sent to users.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the email template. -
body body putEmailTemplates true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content EmailTemplate
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Delete an Email Template

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates/e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates/e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /email-templates/{id}

Deletes an email template. An email template configures email content that is sent to users.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the email template. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content EmailTemplate
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Email Template

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates/e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/email-templates/e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "e3aa6a44-15e8-4abb-bcd4-1bc5c20344e3",
  "identityProvider": {
    "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
  },
  "sender": {
    "email": "noreply@cckc.com",
    "name": "Care KC",
    "replyTo": "do-not-reply@cckc.com",
    "returnPath": "carekc@cckc.com"
  },
  "subject": "Reset Password",
  "type": "PASSWORD_RESET",
  "emailBody": [
    {
      "locale": "en-US",
      "html": "<!DOCTYPE html> <html> <head> <title>Page Title</title> </head><body> <p>Hi,</p> <p>your verification code is: {{verification_code}}.</p><p>Thank you.</p> </body> </html>",
      "text": "Hi, your verification code is: {{verification_code}}. Thank you."
    }
  ]
}

GET /email-templates/{id}

Retrieves a single email template. An email template configures email content that is sent to users.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the email template. -

Response Statuses

Status Meaning Description Schema
200 OK Success EmailTemplate
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Create an Identity Provider

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers', headers: headers, body: {"name":"Care KC","samlMetadata":{"baseSamlLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2","entityId":"https://cckc.consumeridp.us.healtheintent.com/saml2/metadata","singleSignOnPostLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2/sso/redirect","singleLogoutServiceRedirectLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2/slo/logout","x509Certificate":"MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs","secretKey":"MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs","algorithm":"sha256","organizationName":"Cerner","organizationUrl":"www.cckc.org","technicalContact":{"company":"Care KC","givenName":"First Name","surname":"Last Name","telephone":"(000) 000-0000","emailAddress":"firstnamelastname@email.com"}},"status":"ACTIVE","description":"The identity provider for Care KC employee.","chLogoutUrl":"https://cernerhealth.com/logout","updateConsumer":true,"realm":"9825cfd8-dbff-4a29-bafa-21b618d67b34","defaultLoginUrl":"https://carekc.consumerportal.healtheintent.com","signUpUrl":"https://carekc.consumerportal.healtheintent.com/signup","support":{"email":"support@cckc.com","phone":"(913) 555-5555"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Care KC","samlMetadata":{"baseSamlLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2","entityId":"https://cckc.consumeridp.us.healtheintent.com/saml2/metadata","singleSignOnPostLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2/sso/redirect","singleLogoutServiceRedirectLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2/slo/logout","x509Certificate":"MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs","secretKey":"MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs","algorithm":"sha256","organizationName":"Cerner","organizationUrl":"www.cckc.org","technicalContact":{"company":"Care KC","givenName":"First Name","surname":"Last Name","telephone":"(000) 000-0000","emailAddress":"firstnamelastname@email.com"}},"status":"ACTIVE","description":"The identity provider for Care KC employee.","chLogoutUrl":"https://cernerhealth.com/logout","updateConsumer":true,"realm":"9825cfd8-dbff-4a29-bafa-21b618d67b34","defaultLoginUrl":"https://carekc.consumerportal.healtheintent.com","signUpUrl":"https://carekc.consumerportal.healtheintent.com/signup","support":{"email":"support@cckc.com","phone":"(913) 555-5555"}}

Example response

{
  "id": "2ac452cd-f013-4144-9bae-6cc3665047dc",
  "name": "Care KC",
  "samlMetadata": {
    "baseSamlLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2",
    "entityId": "https://cckc.consumeridp.us.healtheintent.com/saml2/metadata",
    "singleSignOnPostLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2/sso/redirect",
    "singleLogoutServiceRedirectLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2/slo/logout",
    "x509Certificate": "MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs",
    "secretKey": "MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs",
    "algorithm": "sha256",
    "organizationName": "Cerner",
    "organizationUrl": "www.cckc.org",
    "technicalContact": {
      "company": "Care KC",
      "givenName": "First Name",
      "surname": "Last Name",
      "telephone": "(000) 000-0000",
      "emailAddress": "firstnamelastname@email.com"
    }
  },
  "status": "ACTIVE",
  "description": "The identity provider for Care KC employee.",
  "chLogoutUrl": "https://cernerhealth.com/logout",
  "updateConsumer": true,
  "realm": "9825cfd8-dbff-4a29-bafa-21b618d67b34",
  "defaultLoginUrl": "https://carekc.consumerportal.healtheintent.com",
  "signUpUrl": "https://carekc.consumerportal.healtheintent.com/signup",
  "support": {
    "email": "support@cckc.com",
    "phone": "(913) 555-5555"
  }
}

POST /identity-providers

Creates an identity provider. The identity provider is the authority that verifies a user’s identity and access to a service provider.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postIdentityProviders true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created IdentityProvider
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of Identity Providers

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "2ac452cd-f013-4144-9bae-6cc3665047dc",
      "name": "Care KC",
      "samlMetadata": {
        "baseSamlLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2",
        "entityId": "https://cckc.consumeridp.us.healtheintent.com/saml2/metadata",
        "singleSignOnPostLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2/sso/redirect",
        "singleLogoutServiceRedirectLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2/slo/logout",
        "x509Certificate": "MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs",
        "secretKey": "MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs",
        "algorithm": "sha256",
        "organizationName": "Cerner",
        "organizationUrl": "www.cckc.org",
        "technicalContact": {
          "company": "Care KC",
          "givenName": "First Name",
          "surname": "Last Name",
          "telephone": "(000) 000-0000",
          "emailAddress": "firstnamelastname@email.com"
        }
      },
      "status": "ACTIVE",
      "description": "The identity provider for Care KC employee.",
      "chLogoutUrl": "https://cernerhealth.com/logout",
      "updateConsumer": true,
      "realm": "9825cfd8-dbff-4a29-bafa-21b618d67b34",
      "defaultLoginUrl": "https://carekc.consumerportal.healtheintent.com",
      "signUpUrl": "https://carekc.consumerportal.healtheintent.com/signup",
      "support": {
        "email": "support@cckc.com",
        "phone": "(913) 555-5555"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers?offset=0&limit=20"
}

GET /identity-providers

Retrieves a list of identity providers. The identity provider is the authority that verifies a user’s identity and access to a service provider.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success IdentityProviders
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update an Identity Provider

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers/2ac452cd-f013-4144-9bae-6cc3665047dc', headers: headers, body: {"name":"Care KC","samlMetadata":{"baseSamlLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2","entityId":"https://cckc.consumeridp.us.healtheintent.com/saml2/metadata","singleSignOnPostLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2/sso/redirect","singleLogoutServiceRedirectLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2/slo/logout","x509Certificate":"MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs","secretKey":"MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs","algorithm":"sha256","organizationName":"Cerner","organizationUrl":"www.cckc.org","technicalContact":{"company":"Care KC","givenName":"First Name","surname":"Last Name","telephone":"(000) 000-0000","emailAddress":"firstnamelastname@email.com"}},"status":"ACTIVE","description":"The identity provider for Care KC employee.","chLogoutUrl":"https://cernerhealth.com/logout","updateConsumer":true,"realm":"9825cfd8-dbff-4a29-bafa-21b618d67b34","defaultLoginUrl":"https://carekc.consumerportal.healtheintent.com","signUpUrl":"https://carekc.consumerportal.healtheintent.com/signup","support":{"email":"support@cckc.com","phone":"(913) 555-5555"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers/2ac452cd-f013-4144-9bae-6cc3665047dc \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Care KC","samlMetadata":{"baseSamlLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2","entityId":"https://cckc.consumeridp.us.healtheintent.com/saml2/metadata","singleSignOnPostLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2/sso/redirect","singleLogoutServiceRedirectLocation":"https://cckc.consumeridp.us.healtheintent.com/saml2/slo/logout","x509Certificate":"MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs","secretKey":"MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs","algorithm":"sha256","organizationName":"Cerner","organizationUrl":"www.cckc.org","technicalContact":{"company":"Care KC","givenName":"First Name","surname":"Last Name","telephone":"(000) 000-0000","emailAddress":"firstnamelastname@email.com"}},"status":"ACTIVE","description":"The identity provider for Care KC employee.","chLogoutUrl":"https://cernerhealth.com/logout","updateConsumer":true,"realm":"9825cfd8-dbff-4a29-bafa-21b618d67b34","defaultLoginUrl":"https://carekc.consumerportal.healtheintent.com","signUpUrl":"https://carekc.consumerportal.healtheintent.com/signup","support":{"email":"support@cckc.com","phone":"(913) 555-5555"}}

PUT /identity-providers/{id}

Updates an identity provider. The identity provider is the authority that verifies a user’s identity and access to a service provider.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the identity provider. -
body body putIdentityProviders true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content IdentityProvider
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Delete an Identity Provider

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers/2ac452cd-f013-4144-9bae-6cc3665047dc', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers/2ac452cd-f013-4144-9bae-6cc3665047dc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /identity-providers/{id}

Deletes an identity provider. The identity provider is the authority that verifies a user’s identity and access to a service provider.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the identity provider. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content IdentityProvider
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Identity Provider

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers/2ac452cd-f013-4144-9bae-6cc3665047dc', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/identity-providers/2ac452cd-f013-4144-9bae-6cc3665047dc \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "2ac452cd-f013-4144-9bae-6cc3665047dc",
  "name": "Care KC",
  "samlMetadata": {
    "baseSamlLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2",
    "entityId": "https://cckc.consumeridp.us.healtheintent.com/saml2/metadata",
    "singleSignOnPostLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2/sso/redirect",
    "singleLogoutServiceRedirectLocation": "https://cckc.consumeridp.us.healtheintent.com/saml2/slo/logout",
    "x509Certificate": "MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs",
    "secretKey": "MIICXAIBAAKBgQC4HLA82ULUWikYth8X3pKi2Irw2Pr+dbTzg7iiZEyJ/PLvH3nlEsTLrverZqIk0Hcu8Tpe+S31wa3G02g5fDWDZS8cqmV1Buvps4SMs14M1buPShv4mtG8BQ4r0JGB3LDkwLqXCpVBDkLUOdpP/Z9IEWNqwEVNHbh0Sl9PLwd8oQIDAQABAoGAQmUGIUtwUEgbXe//kooPc26H3IdDLJSiJtcvtFBbUb/Ik/dT7AoysgltA4DFpGURNfqERE+0BVZNJtCCW4ixew4uEhk1XowYXHCzjkzyYoFuT9v5SP4cu4q3t1kK51JF237F0eCY3qC3k96CzPGG67bwOu9EeXAu4ka/plLdsAECQQDkg0uhR/vsJffxtiWxcDRNFoZpCpzpdWfQBnHBzj9ZC0xrdVilxBgBpupCljO2Scy4MeiY4S1MleelCWRqh7RBAkEAzkIjUnllEkr5sjVb7pNy+e/eakuDxvZck0Z8X3USUki/Nm3E/GPPc+CwmXR4QlpMpJr3/Prf1j59l/LAK9AwYQJBAL9eRSQYCJ3HXlGKXR6v/NziFEY7oRTSQdIw02ueseZ8U89aQpbwFbqsclq5Ny1duJg5E7WUPj94+rl3mCSu6QECQBVh0duY7htpXl1VHsSq0H6MmVgXn/+eRpaV9grHTjDtjbUMyCEKD9WJc4VVB6qJRezCi/bT4ySIs",
    "algorithm": "sha256",
    "organizationName": "Cerner",
    "organizationUrl": "www.cckc.org",
    "technicalContact": {
      "company": "Care KC",
      "givenName": "First Name",
      "surname": "Last Name",
      "telephone": "(000) 000-0000",
      "emailAddress": "firstnamelastname@email.com"
    }
  },
  "status": "ACTIVE",
  "description": "The identity provider for Care KC employee.",
  "chLogoutUrl": "https://cernerhealth.com/logout",
  "updateConsumer": true,
  "realm": "9825cfd8-dbff-4a29-bafa-21b618d67b34",
  "defaultLoginUrl": "https://carekc.consumerportal.healtheintent.com",
  "signUpUrl": "https://carekc.consumerportal.healtheintent.com/signup",
  "support": {
    "email": "support@cckc.com",
    "phone": "(913) 555-5555"
  }
}

GET /identity-providers/{id}

Retrieves a single identity provider. The identity provider is the authority that verifies a user’s identity and access to a service provider.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the identity provider. -

Response Statuses

Status Meaning Description Schema
200 OK Success IdentityProvider
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Create a Site Configuration

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs', headers: headers, body: {"domain":{"id":"f8ab4952-81fa-4a99-93e7-ec113d53b635"},"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"},"brand":{"id":"edf515ac-9d19-42c2-8b6a-342ec27f49e6"},"banner":{"type":"INFO","localizedTexts":{"locale":"en-US","text":"A text value in English."}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":{"id":"f8ab4952-81fa-4a99-93e7-ec113d53b635"},"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"},"brand":{"id":"edf515ac-9d19-42c2-8b6a-342ec27f49e6"},"banner":{"type":"INFO","localizedTexts":{"locale":"en-US","text":"A text value in English."}}}

Example response

{
  "id": "f8e0a657-fd07-4593-9dde-02550ca1e928",
  "domain": {
    "id": "f8ab4952-81fa-4a99-93e7-ec113d53b635"
  },
  "identityProvider": {
    "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
  },
  "brand": {
    "id": "edf515ac-9d19-42c2-8b6a-342ec27f49e6"
  },
  "createdAt": "2020-05-09T14:50:45Z",
  "updatedAt": "2020-05-09T14:50:45Z",
  "banner": {
    "type": "INFO",
    "localizedTexts": {
      "locale": "en-US",
      "text": "A text value in English."
    }
  }
}

POST /site-configs

Creates a site configuration. A site configuration defines the domain, brand, and identity provider for a specified consumer identity provider site.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postSiteConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created SiteConfig
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of Site Configurations

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "f8e0a657-fd07-4593-9dde-02550ca1e928",
      "domain": {
        "id": "f8ab4952-81fa-4a99-93e7-ec113d53b635"
      },
      "identityProvider": {
        "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
      },
      "brand": {
        "id": "edf515ac-9d19-42c2-8b6a-342ec27f49e6"
      },
      "createdAt": "2020-05-09T14:50:45Z",
      "updatedAt": "2020-05-09T14:50:45Z",
      "banner": {
        "type": "INFO",
        "localizedTexts": {
          "locale": "en-US",
          "text": "A text value in English."
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs?offset=0&limit=20"
}

GET /site-configs

Retrieves a list of site configurations. A site configuration defines the domain, brand, and identity provider for a specified consumer identity provider site.

Parameters

Parameter In Type Required Default Description Accepted Values
domainId query string false N/A Filters by the ID of the domain. -
identityProviderId query string false N/A Filters by the ID of the identity provider. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success SiteConfigs
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update a Site Configuration

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs/f8e0a657-fd07-4593-9dde-02550ca1e928', headers: headers, body: {"domain":{"id":"f8ab4952-81fa-4a99-93e7-ec113d53b635"},"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"},"brand":{"id":"edf515ac-9d19-42c2-8b6a-342ec27f49e6"},"banner":{"type":"INFO","localizedTexts":{"locale":"en-US","text":"A text value in English."}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs/f8e0a657-fd07-4593-9dde-02550ca1e928 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":{"id":"f8ab4952-81fa-4a99-93e7-ec113d53b635"},"identityProvider":{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"},"brand":{"id":"edf515ac-9d19-42c2-8b6a-342ec27f49e6"},"banner":{"type":"INFO","localizedTexts":{"locale":"en-US","text":"A text value in English."}}}

PUT /site-configs/{id}

Updates a site configuration record by ID. A site configuration defines the domain, brand, and identity provider for a specified consumer identity provider site.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the site configuration. -
body body putSiteConfigs true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content SiteConfig
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Remove a Site Configuration

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs/f8e0a657-fd07-4593-9dde-02550ca1e928', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs/f8e0a657-fd07-4593-9dde-02550ca1e928 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /site-configs/{id}

Removes a site configuration record by ID. A site configuration defines the domain, brand, and identity provider for a specified consumer identity provider site.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the site configuration. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content SiteConfig
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Site Configuration

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs/f8e0a657-fd07-4593-9dde-02550ca1e928', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/site-configs/f8e0a657-fd07-4593-9dde-02550ca1e928 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "f8e0a657-fd07-4593-9dde-02550ca1e928",
  "domain": {
    "id": "f8ab4952-81fa-4a99-93e7-ec113d53b635"
  },
  "identityProvider": {
    "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
  },
  "brand": {
    "id": "edf515ac-9d19-42c2-8b6a-342ec27f49e6"
  },
  "createdAt": "2020-05-09T14:50:45Z",
  "updatedAt": "2020-05-09T14:50:45Z",
  "banner": {
    "type": "INFO",
    "localizedTexts": {
      "locale": "en-US",
      "text": "A text value in English."
    }
  }
}

GET /site-configs/{id}

Retrieves a single site configuration record by ID. A site configuration defines the domain, brand, and identity provider for a specified consumer identity provider site.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the site configuration. -

Response Statuses

Status Meaning Description Schema
200 OK Success SiteConfig
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Registration

A sign-up token stores information about a user. Sign-up tokens are required to register a consumer for an identity provider.

Create a Sign-Up Token

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens', headers: headers, body: {"redirectUrl":"https://service-provider.example.com/complete-registration","emailAddress":"john.doe@example.com","firstName":"First Name","lastName":"Last Name","dateOfBirth":"1990-12-20","mobileNumber":"(123) 555-1234","gender":"MALE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"redirectUrl":"https://service-provider.example.com/complete-registration","emailAddress":"john.doe@example.com","firstName":"First Name","lastName":"Last Name","dateOfBirth":"1990-12-20","mobileNumber":"(123) 555-1234","gender":"MALE"}

Example response

{
  "id": "c9131706-d272-444d-abe8-30ee4c6e68dd",
  "redirectUrl": "https://service-provider.example.com/complete-registration",
  "emailAddress": "john.doe@example.com",
  "firstName": "First Name",
  "lastName": "Last Name",
  "dateOfBirth": "1990-12-20",
  "mobileNumber": "(123) 555-1234",
  "gender": "MALE"
}

POST /signup-tokens

Creates a sign-up token for a user. A sign-up token stores information about the user. This information is used when the user signs up with HealtheIntent Consumer Identity Provider.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postSignupTokens true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created SignupToken
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of Sign-Up Tokens

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "c9131706-d272-444d-abe8-30ee4c6e68dd",
      "redirectUrl": "https://service-provider.example.com/complete-registration",
      "emailAddress": "john.doe@example.com",
      "firstName": "First Name",
      "lastName": "Last Name",
      "dateOfBirth": "1990-12-20",
      "mobileNumber": "(123) 555-1234",
      "gender": "MALE"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens?offset=0&limit=20"
}

GET /signup-tokens

Retrieves a list of sign-up tokens. A sign-up token stores information about the user. This information is used when the user signs up with HealtheIntent Consumer Identity Provider.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success SignupTokens
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update a Sign-Up Token

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens/c9131706-d272-444d-abe8-30ee4c6e68dd', headers: headers, body: {"redirectUrl":"https://service-provider.example.com/complete-registration","emailAddress":"john.doe@example.com","firstName":"First Name","lastName":"Last Name","dateOfBirth":"1990-12-20","mobileNumber":"(123) 555-1234","gender":"MALE"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens/c9131706-d272-444d-abe8-30ee4c6e68dd \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"redirectUrl":"https://service-provider.example.com/complete-registration","emailAddress":"john.doe@example.com","firstName":"First Name","lastName":"Last Name","dateOfBirth":"1990-12-20","mobileNumber":"(123) 555-1234","gender":"MALE"}

PUT /signup-tokens/{id}

Updates a single sign-up token record by ID. A sign-up token stores information about the user. This information is used when the user signs up with HealtheIntent Consumer Identity Provider.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the sign-up token. -
body body putSignupTokens true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content SignupToken
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Remove a Sign-Up Token

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens/c9131706-d272-444d-abe8-30ee4c6e68dd', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens/c9131706-d272-444d-abe8-30ee4c6e68dd \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /signup-tokens/{id}

Removes a single sign-up token record by ID. A sign-up token stores information about the user. This information is used when the user signs up with HealtheIntent Consumer Identity Provider.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the sign-up token. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content SignupToken
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Sign-Up Token

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens/c9131706-d272-444d-abe8-30ee4c6e68dd', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/signup-tokens/c9131706-d272-444d-abe8-30ee4c6e68dd \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "c9131706-d272-444d-abe8-30ee4c6e68dd",
  "redirectUrl": "https://service-provider.example.com/complete-registration",
  "emailAddress": "john.doe@example.com",
  "firstName": "First Name",
  "lastName": "Last Name",
  "dateOfBirth": "1990-12-20",
  "mobileNumber": "(123) 555-1234",
  "gender": "MALE"
}

GET /signup-tokens/{id}

Retrieves a single sign-up token record by ID. A sign-up token stores information about the user. This information is used when the user signs up with HealtheIntent Consumer Identity Provider.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the sign-up token. -

Response Statuses

Status Meaning Description Schema
200 OK Success SignupToken
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

User Management

Users and user groups allow you to manage users for an identity provider.

Create a User Group

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups', headers: headers, body: {"name":"CareKC Primary Employee Group.","identityProviders":[{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"}],"description":"Group representing employees of CareKC."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"CareKC Primary Employee Group.","identityProviders":[{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"}],"description":"Group representing employees of CareKC."}

Example response

{
  "id": "356f8169-5b35-4d82-962c-c5e213f3e3ee",
  "name": "CareKC Primary Employee Group.",
  "description": "Group representing employees of CareKC.",
  "identityProviders": [
    {
      "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
    }
  ]
}

POST /user-groups

Creates a user group. A user group is a set of users who receive the same access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postUserGroups true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created UserGroup
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of User Groups

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "356f8169-5b35-4d82-962c-c5e213f3e3ee",
      "name": "CareKC Primary Employee Group.",
      "description": "Group representing employees of CareKC.",
      "identityProviders": [
        {
          "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups?offset=0&limit=20"
}

GET /user-groups

Retrieves a list of user groups. A user group is a set of users who receive the same access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
identityProviderId query string false N/A Filters by the ID of the identity provider. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success UserGroups
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update a User Group

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups/356f8169-5b35-4d82-962c-c5e213f3e3ee', headers: headers, body: {"name":"CareKC Primary Employee Group.","identityProviders":[{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"}],"description":"Group representing employees of CareKC."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups/356f8169-5b35-4d82-962c-c5e213f3e3ee \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"CareKC Primary Employee Group.","identityProviders":[{"id":"0abf1d19-845f-44be-851e-5d9c08e58828"}],"description":"Group representing employees of CareKC."}

PUT /user-groups/{id}

Updates a user group. A user group is a set of users who receive the same access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the user group. -
body body putUserGroups true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content UserGroup
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Remove a User Group

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups/356f8169-5b35-4d82-962c-c5e213f3e3ee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups/356f8169-5b35-4d82-962c-c5e213f3e3ee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /user-groups/{id}

Removes a user group. A user group is a set of users who receive the same access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the user group. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content UserGroup
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single User Group

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups/356f8169-5b35-4d82-962c-c5e213f3e3ee', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/user-groups/356f8169-5b35-4d82-962c-c5e213f3e3ee \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "356f8169-5b35-4d82-962c-c5e213f3e3ee",
  "name": "CareKC Primary Employee Group.",
  "description": "Group representing employees of CareKC.",
  "identityProviders": [
    {
      "id": "0abf1d19-845f-44be-851e-5d9c08e58828"
    }
  ]
}

GET /user-groups/{id}

Retrieves a single user group. A user group is a set of users who receive the same access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the user group. -

Response Statuses

Status Meaning Description Schema
200 OK Success UserGroup
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Create a User

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users', headers: headers, body: {"emailAddress":"firstnamelastname@email.com","userGroup":{"id":"356f8169-5b35-4d82-962c-c5e213f3e3ee"},"identityFabricUser":{"id":"30916894-eb3d-4d44-92dd-a7c2629ad382","username":"user@email.com"},"firstName":"First Name","lastName":"Last Name","gender":"MALE","dateOfBirth":"1990-12-20","mobileNumber":"(000) 000-0000"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"emailAddress":"firstnamelastname@email.com","userGroup":{"id":"356f8169-5b35-4d82-962c-c5e213f3e3ee"},"identityFabricUser":{"id":"30916894-eb3d-4d44-92dd-a7c2629ad382","username":"user@email.com"},"firstName":"First Name","lastName":"Last Name","gender":"MALE","dateOfBirth":"1990-12-20","mobileNumber":"(000) 000-0000"}

Example response

{
  "id": "b65fe29d-b269-4e29-80d6-174ce724c8b4",
  "emailAddress": "firstnamelastname@email.com",
  "userGroup": {
    "id": "356f8169-5b35-4d82-962c-c5e213f3e3ee"
  },
  "identityFabricUser": {
    "id": "30916894-eb3d-4d44-92dd-a7c2629ad382",
    "username": "user@email.com"
  },
  "firstName": "First Name",
  "lastName": "Last Name",
  "gender": "MALE",
  "dateOfBirth": "1990-12-20",
  "mobileNumber": "(000) 000-0000",
  "principal": "b4970215-0077-4814-85e3-920427e6d07a"
}

POST /users

Creates a user. A user in the Consumer Identity Provider has access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postUsers true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created User
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Retrieve a List of Users

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "b65fe29d-b269-4e29-80d6-174ce724c8b4",
      "emailAddress": "firstnamelastname@email.com",
      "userGroup": {
        "id": "356f8169-5b35-4d82-962c-c5e213f3e3ee"
      },
      "identityFabricUser": {
        "id": "30916894-eb3d-4d44-92dd-a7c2629ad382",
        "username": "user@email.com"
      },
      "firstName": "First Name",
      "lastName": "Last Name",
      "gender": "MALE",
      "dateOfBirth": "1990-12-20",
      "mobileNumber": "(000) 000-0000",
      "principal": "b4970215-0077-4814-85e3-920427e6d07a"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users?offset=0&limit=20"
}

GET /users

Retrieves a list of users. A user in the Consumer Identity Provider has access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
emailAddress query string false N/A Filters by the email address of a user. -
firstName query string false N/A Filters by the first name of a user. -
lastName query string false N/A Filters by the last name of a user. -
userGroupId query string false N/A Filters by the ID of the user group. -
principal query string false N/A Filters by the principal of the user. -
dateOfBirth query string false N/A Filters by the date of birth of the user. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK Success Users
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Update a User

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users/b65fe29d-b269-4e29-80d6-174ce724c8b4', headers: headers, body: {"emailAddress":"firstnamelastname@email.com","userGroup":{"id":"356f8169-5b35-4d82-962c-c5e213f3e3ee"},"identityFabricUser":{"id":"30916894-eb3d-4d44-92dd-a7c2629ad382","username":"user@email.com"},"firstName":"First Name","lastName":"Last Name","gender":"MALE","dateOfBirth":"1990-12-20","mobileNumber":"(000) 000-0000"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users/b65fe29d-b269-4e29-80d6-174ce724c8b4 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"emailAddress":"firstnamelastname@email.com","userGroup":{"id":"356f8169-5b35-4d82-962c-c5e213f3e3ee"},"identityFabricUser":{"id":"30916894-eb3d-4d44-92dd-a7c2629ad382","username":"user@email.com"},"firstName":"First Name","lastName":"Last Name","gender":"MALE","dateOfBirth":"1990-12-20","mobileNumber":"(000) 000-0000"}

PUT /users/{id}

Updates a user. A user in the Consumer Identity Provider has access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the user. -
body body putUsers true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content User
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Remove a User

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users/b65fe29d-b269-4e29-80d6-174ce724c8b4', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users/b65fe29d-b269-4e29-80d6-174ce724c8b4 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /users/{id}

Removes a user. A user in the Consumer Identity Provider has access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the user. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content User
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single User

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users/b65fe29d-b269-4e29-80d6-174ce724c8b4', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/consumer-identity-provider/v1/users/b65fe29d-b269-4e29-80d6-174ce724c8b4 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "b65fe29d-b269-4e29-80d6-174ce724c8b4",
  "emailAddress": "firstnamelastname@email.com",
  "userGroup": {
    "id": "356f8169-5b35-4d82-962c-c5e213f3e3ee"
  },
  "identityFabricUser": {
    "id": "30916894-eb3d-4d44-92dd-a7c2629ad382",
    "username": "user@email.com"
  },
  "firstName": "First Name",
  "lastName": "Last Name",
  "gender": "MALE",
  "dateOfBirth": "1990-12-20",
  "mobileNumber": "(000) 000-0000",
  "principal": "b4970215-0077-4814-85e3-920427e6d07a"
}

GET /users/{id}

Retrieves a single user. A user in the Consumer Identity Provider has access to the HealtheIntent applications associated with their tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the user. -

Response Statuses

Status Meaning Description Schema
200 OK Success User
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Schema Definitions

postBrands

Name Type Required Description Accepted Values
name string true The name of the brand. -
logo object false The logo of the brand. -
» src string true The URL where the logo image is located. -
» localizedTexts [object] false A list of localized texts that provide text descriptions for the logo. -
»» locale string true The locale of the text. Ensure that the locale matches the ISO 639-1 specification. -
»» text string true The localized value of the text. -
backgroundImage object false The background image of the brand. -
» src string true The URL where the background image is located. -
» localizedTexts [object] false A list of localized texts that provide text descriptions for the background image. -
»» locale string true The locale of the text. Ensure that the locale matches the ISO 639-1 specification. -
»» text string true The localized value of the text. -
customFontScripts [object] false A list of customizable scripts that enable you to define custom fonts. -
» async boolean true Indicates whether the browser asynchronously retrieves the custom font script while parsing the HTML. -
» defer boolean true Indicates whether the browser defers the custom font script execution until after the HTML parsing is complete. -
» src string false The URL where the custom font script is located. You must include either src or text, but not both. -
» text string false The raw JavaScript code of the custom font script. You must include either src or text, but not both. -
» integrity string false The Base64-encoded SHA-384 value that the browser compares with the retrieved custom font script for a match. -
webAnalyticsScripts [object] false A list of customizable scripts that enable you to add web analytic functionality. -
» async boolean true Indicates whether the browser asynchronously retrieves the web analytics script while parsing the HTML. -
» defer boolean true Indicates whether the browser defers the web analytics script execution until after the HTML parsing is complete. -
» src string false The URL where the custom font script is located. Either src or text must be included, but not both. -
» text string false The raw JavaScript code of the custom font script. Either src or text must be included, but not both. -
» integrity string false The Base64-encoded SHA-384 value that the browser compares with the retrieved web analytics script for a match. -

Brand

Name Type Required Description Accepted Values
id string true The ID of the brand. -
name string true The name of the brand. -
logo Logo false The logo of the brand. -
backgroundImage BackgroundImage false The background image of the brand. -
customFontScripts [CustomFontScript] false A list of customizable scripts that enable you to define custom fonts. -
webAnalyticsScripts [WebAnalyticsScript] false A list of customizable scripts that enable you to add web analytic functionality. -

Name Type Required Description Accepted Values
src string true The URL where the logo image is located. -
localizedTexts [LocalizedText] false A list of localized texts that provide text descriptions for the logo. -

LocalizedText

Name Type Required Description Accepted Values
locale string true The locale of the text. Ensure that the locale matches the ISO 639-1 specification. -
text string true The localized value of the text. -

BackgroundImage

Name Type Required Description Accepted Values
src string true The URL where the background image is located. -
localizedTexts [LocalizedText] false A list of localized texts that provide text descriptions for the background image. -

CustomFontScript

Name Type Required Description Accepted Values
async boolean true Indicates whether the browser asynchronously retrieves the custom font script while parsing the HTML. -
defer boolean true Indicates whether the browser defers the custom font script execution until after the HTML parsing is complete. -
src string false The URL where the custom font script is located. You must include either src or text, but not both. -
text string false The raw JavaScript code of the custom font script. You must include either src or text, but not both. -
integrity string false The Base64-encoded SHA-384 value that the browser compares with the retrieved custom font script for a match. -

WebAnalyticsScript

Name Type Required Description Accepted Values
async boolean true Indicates whether the browser asynchronously retrieves the web analytics script while parsing the HTML. -
defer boolean true Indicates whether the browser defers the web analytics script execution until after the HTML parsing is complete. -
src string false The URL where the custom font script is located. Either src or text must be included, but not both. -
text string false The raw JavaScript code of the custom font script. Either src or text must be included, but not both. -
integrity string false The Base64-encoded SHA-384 value that the browser compares with the retrieved web analytics script for a match. -

HealtheintentApi_Common_Models_Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [HealtheintentApi_Common_Models_ErrorDetail] false A list of additional error details. -

HealtheintentApi_Common_Models_ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

Brands

Name Type Required Description Accepted Values
items [Brand] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putBrands

Name Type Required Description Accepted Values
name string true The name of the brand. -
logo object false The logo of the brand. -
» src string true The URL where the logo image is located. -
» localizedTexts [object] false A list of localized texts that provide text descriptions for the logo. -
»» locale string true The locale of the text. Ensure that the locale matches the ISO 639-1 specification. -
»» text string true The localized value of the text. -
backgroundImage object false The background image of the brand. -
» src string true The URL where the background image is located. -
» localizedTexts [object] false A list of localized texts that provide text descriptions for the background image. -
»» locale string true The locale of the text. Ensure that the locale matches the ISO 639-1 specification. -
»» text string true The localized value of the text. -
customFontScripts [object] false A list of customizable scripts that enable you to define custom fonts. -
» async boolean true Indicates whether the browser asynchronously retrieves the custom font script while parsing the HTML. -
» defer boolean true Indicates whether the browser defers the custom font script execution until after the HTML parsing is complete. -
» src string false The URL where the custom font script is located. You must include either src or text, but not both. -
» text string false The raw JavaScript code of the custom font script. You must include either src or text, but not both. -
» integrity string false The Base64-encoded SHA-384 value that the browser compares with the retrieved custom font script for a match. -
webAnalyticsScripts [object] false A list of customizable scripts that enable you to add web analytic functionality. -
» async boolean true Indicates whether the browser asynchronously retrieves the web analytics script while parsing the HTML. -
» defer boolean true Indicates whether the browser defers the web analytics script execution until after the HTML parsing is complete. -
» src string false The URL where the custom font script is located. Either src or text must be included, but not both. -
» text string false The raw JavaScript code of the custom font script. Either src or text must be included, but not both. -
» integrity string false The Base64-encoded SHA-384 value that the browser compares with the retrieved web analytics script for a match. -

postEmailTemplates

Name Type Required Description Accepted Values
identityProvider object true The reference to the identity provider to which the email template belongs. -
» id string true The ID of the identity provider. -
sender object true Details about the sender of the email. -
» email string true The email address of the sender that is displayed to the recipient. -
» name string false The name of the sender that is displayed to the recipient. -
» replyTo string false The email address suggested to the user if they reply to the email. -
» returnPath string false The location where nondelivery receipts are sent. -
subject string true The single line of text that is displayed to email recipients when they receive the email in their inbox. -
type string true The current type of the email. The following types are possible:
- PASSWORD_RESET: This email is sent to a user when they attempt to reset their password. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- EMAIL_VERIFICATION: This email is sent to a user when they are registering for their account. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- NEW_EMAIL_VERIFICATION: This email is sent to a user’s new email address when they are changing their email address. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- OLD_EMAIL_NOTIFICATION: This email is sent to a user’s old email address when they are changing their email address. No placeholders are required for this template.**
PASSWORD_RESET, EMAIL_VERIFICATION, NEW_EMAIL_VERIFICATION, OLD_EMAIL_NOTIFICATION
emailBodies [object] true The actual content of the email. -
» locale string true The locale for which an email notification is configured. -
» html string true The body of an email notification. It contains the content of the email in HTML format. -
» text string true The body of an email notification. It contains the content of the email in text format. -

EmailTemplate

Name Type Required Description Accepted Values
id string true The ID of the email template. -
identityProvider IdentityProviderReference true The reference to the identity provider to which the email template belongs. -
sender Sender true Details about the sender of the email. -
subject string true The single line of text that is displayed to email recipients when they receive the email in their inbox. -
type string true The current type of the email. The following types are possible:
- PASSWORD_RESET: This email is sent to a user when they attempt to reset their password. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- EMAIL_VERIFICATION: This email is sent to a user when they are registering for their account. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- NEW_EMAIL_VERIFICATION: This email is sent to a user’s new email address when they are changing their email address. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- OLD_EMAIL_NOTIFICATION: This email is sent to a user’s old email address when they are changing their email address. No placeholders are required for this template.**
PASSWORD_RESET, EMAIL_VERIFICATION, NEW_EMAIL_VERIFICATION, OLD_EMAIL_NOTIFICATION
emailBody [EmailBodyReference] true The actual content of the email. -

IdentityProviderReference

Name Type Required Description Accepted Values
id string true The ID of the identity provider. -

Sender

Name Type Required Description Accepted Values
email string true The email address of the sender that is displayed to the recipient. -
name string false The name of the sender that is displayed to the recipient. -
replyTo string false The email address suggested to the user if they reply to the email. -
returnPath string false The location where nondelivery receipts are sent. -

EmailBodyReference

Name Type Required Description Accepted Values
locale string true The locale for which an email notification is configured. -
html string true The body of an email notification. It contains the content of the email in HTML format. -
text string true The body of an email notification. It contains the content of the email in text format. -

EmailTemplates

Name Type Required Description Accepted Values
items [EmailTemplate] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putEmailTemplates

Name Type Required Description Accepted Values
identityProvider object true The reference to the identity provider to which the email template belongs. -
» id string true The ID of the identity provider. -
sender object true Details about the sender of the email. -
» email string true The email address of the sender that is displayed to the recipient. -
» name string false The name of the sender that is displayed to the recipient. -
» replyTo string false The email address suggested to the user if they reply to the email. -
» returnPath string false The location where nondelivery receipts are sent. -
subject string true The single line of text that is displayed to email recipients when they receive the email in their inbox. -
type string true The current type of the email. The following types are possible:
- PASSWORD_RESET: This email is sent to a user when they attempt to reset their password. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- EMAIL_VERIFICATION: This email is sent to a user when they are registering for their account. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- NEW_EMAIL_VERIFICATION: This email is sent to a user’s new email address when they are changing their email address. It contains a verification code used to verify the user’s identity. This email template requires a verification code placeholder in the email body, such as {{verification_code}}.
- OLD_EMAIL_NOTIFICATION: This email is sent to a user’s old email address when they are changing their email address. No placeholders are required for this template.**
PASSWORD_RESET, EMAIL_VERIFICATION, NEW_EMAIL_VERIFICATION, OLD_EMAIL_NOTIFICATION
emailBodies [object] true The actual content of the email. -
» locale string true The locale for which an email notification is configured. -
» html string true The body of an email notification. It contains the content of the email in HTML format. -
» text string true The body of an email notification. It contains the content of the email in text format. -

postIdentityProviders

Name Type Required Description Accepted Values
name string true The name of the identity provider. -
samlMetadata object true The SAML metadata in an .XML document that contains the information necessary for interaction with a SAML-enabled identity provider. -
» baseSamlLocation string true The base location used by the service provider to initiate a SAML request. -
» entityId string true A globally unique identifier for a consumer identity provider that is used as the entity ID in SAML assertions generated by HealtheIntent Consumer Identity Provider. HealtheIntent Consumer Identity Provider generates the entity ID for each consumer identity provider in the following format: https://CONSUMER_IDP_DOMAIN/saml2/metadata. -
» singleSignOnPostLocation string true The single sign-on (SSO) URL used by the service provider to initiate authentication with a SAML request. -
» singleLogoutServiceRedirectLocation string true The single logout (SLO) URL used by the service provider to initiate a SAML single logout request. -
» x509Certificate string true A certificate used to verify the public key sent by the identity provider in the metadata of a SAML assertion. It allows service providers to verify that the SAML assertion is sent from a trusted identity provider. -
» secretKey string true The secret key that is used in conjunction with the x509 certificate to encrypt SAML elements. -
» algorithm string false The algorithm used to sign the SAML. This algorithm is used in conjunction with the X.509 certificate. -
» organizationName string false The organization name of the tenant in the identity provider SAML metadata. -
» organizationUrl string false The organization site URL of the tenant in the SAML metadata. -
» technicalContact object false The contact details for a person who can assist users with technical questions, such as questions about troubleshooting software, systems, or networking. -
»» company string false The name of the organization providing technical support. -
»» givenName string false The first name of the technical contact person. -
»» surname string false The last name of the technical contact person. -
»» telephone string false The phone number of the technical contact person or group. -
»» emailAddress string false The email address of the technical contact person or group. -
status string false The current status of the identity provider. The following values are possible:
- ACTIVE: The identity provider is available for use.
- MIGRATING: The identity provider is being migrated.
ACTIVE, MIGRATING
description string false The description of the identity provider. -
chLogoutUrl string false The logout URL of the Cerner Health identity provider used to remove user sessions while the identity provider is migrated. -
updateConsumer boolean false Indicates whether the consumer is updated when the user updates their email or demographics. -
realm string false The cloud session realm of the identity provider. See Registering an Identity Realm on the Cerner Wiki for more information. -
defaultLoginUrl string false The URL of the service provider’s log-in initiation endpoint. -
signUpUrl string false The URL of the service provider’s sign up initiation endpoint. -
support object false Technical support for user questions about attribute release policy, user privacy, or access issues relating to assurance. This information is displayed to users in an error page. -
» email string false The email with which a user can contact support. -
» phone string false The phone number with which a user can contact support. -

IdentityProvider

Name Type Required Description Accepted Values
id string true The ID of the identity provider. -
name string true The name of the identity provider. -
samlMetadata SamlMetadata true The SAML metadata in an .XML document that contains the information necessary for interaction with a SAML-enabled identity provider. -
status string true The current status of the identity provider. The following values are possible:
- ACTIVE: The identity provider is available for use.
- MIGRATING: The identity provider is being migrated.
ACTIVE, MIGRATING
description string false The description of the identity provider. -
chLogoutUrl string false The logout URL of the Cerner Health identity provider used to remove user sessions while the identity provider is migrated. -
updateConsumer boolean false Indicates whether the consumer is updated when the user updates their email or demographics. -
realm string false The cloud session realm of the identity provider. See Registering an Identity Realm on the Cerner Wiki for more information. -
defaultLoginUrl string false The URL of the service provider’s log-in initiation endpoint. -
signUpUrl string false The URL of the service provider’s sign up initiation endpoint. -
support Support false Technical support for user questions about attribute release policy, user privacy, or access issues relating to assurance. This information is displayed to users in an error page. -

SamlMetadata

Name Type Required Description Accepted Values
baseSamlLocation string true The base location used by the service provider to initiate a SAML request. -
entityId string true A globally unique identifier for a consumer identity provider that is used as the entity ID in SAML assertions generated by HealtheIntent Consumer Identity Provider. HealtheIntent Consumer Identity Provider generates the entity ID for each consumer identity provider in the following format: https://CONSUMER_IDP_DOMAIN/saml2/metadata. -
singleSignOnPostLocation string true The single sign-on (SSO) URL used by the service provider to initiate authentication with a SAML request. -
singleLogoutServiceRedirectLocation string true The single logout (SLO) URL used by the service provider to initiate a SAML single logout request. -
x509Certificate string true A certificate used to verify the public key sent by the identity provider in the metadata of a SAML assertion. It allows service providers to verify that the SAML assertion is sent from a trusted identity provider. -
secretKey string true The secret key that is used in conjunction with the x509 certificate to encrypt SAML elements. -
algorithm string true The algorithm used to sign the SAML. This algorithm is used in conjunction with the X.509 certificate. -
organizationName string false The organization name of the tenant in the identity provider SAML metadata. -
organizationUrl string false The organization site URL of the tenant in the SAML metadata. -
technicalContact TechnicalContact false The contact details for a person who can assist users with technical questions, such as questions about troubleshooting software, systems, or networking. -

TechnicalContact

Name Type Required Description Accepted Values
company string false The name of the organization providing technical support. -
givenName string false The first name of the technical contact person. -
surname string false The last name of the technical contact person. -
telephone string false The phone number of the technical contact person or group. -
emailAddress string false The email address of the technical contact person or group. -

Support

Name Type Required Description Accepted Values
email string false The email with which a user can contact support. -
phone string false The phone number with which a user can contact support. -

IdentityProviders

Name Type Required Description Accepted Values
items [IdentityProvider] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putIdentityProviders

Name Type Required Description Accepted Values
name string true The name of the identity provider. -
samlMetadata object true The SAML metadata in an .XML document that contains the information necessary for interaction with a SAML-enabled identity provider. -
» baseSamlLocation string true The base location used by the service provider to initiate a SAML request. -
» entityId string true A globally unique identifier for a consumer identity provider that is used as the entity ID in SAML assertions generated by HealtheIntent Consumer Identity Provider. HealtheIntent Consumer Identity Provider generates the entity ID for each consumer identity provider in the following format: https://CONSUMER_IDP_DOMAIN/saml2/metadata. -
» singleSignOnPostLocation string true The single sign-on (SSO) URL used by the service provider to initiate authentication with a SAML request. -
» singleLogoutServiceRedirectLocation string true The single logout (SLO) URL used by the service provider to initiate a SAML single logout request. -
» x509Certificate string true A certificate used to verify the public key sent by the identity provider in the metadata of a SAML assertion. It allows service providers to verify that the SAML assertion is sent from a trusted identity provider. -
» secretKey string true The secret key that is used in conjunction with the x509 certificate to encrypt SAML elements. -
» algorithm string false The algorithm used to sign the SAML. This algorithm is used in conjunction with the X.509 certificate. -
» organizationName string false The organization name of the tenant in the identity provider SAML metadata. -
» organizationUrl string false The organization site URL of the tenant in the SAML metadata. -
» technicalContact object false The contact details for a person who can assist users with technical questions, such as questions about troubleshooting software, systems, or networking. -
»» company string false The name of the organization providing technical support. -
»» givenName string false The first name of the technical contact person. -
»» surname string false The last name of the technical contact person. -
»» telephone string false The phone number of the technical contact person or group. -
»» emailAddress string false The email address of the technical contact person or group. -
status string false The current status of the identity provider. The following values are possible:
- ACTIVE: The identity provider is available for use.
- MIGRATING: The identity provider is being migrated.
ACTIVE, MIGRATING
description string false The description of the identity provider. -
chLogoutUrl string false The logout URL of the Cerner Health identity provider used to remove user sessions while the identity provider is migrated. -
updateConsumer boolean false Indicates whether the consumer is updated when the user updates their email or demographics. -
realm string false The cloud session realm of the identity provider. See Registering an Identity Realm on the Cerner Wiki for more information. -
defaultLoginUrl string false The URL of the service provider’s log-in initiation endpoint. -
signUpUrl string false The URL of the service provider’s sign up initiation endpoint. -
support object false Technical support for user questions about attribute release policy, user privacy, or access issues relating to assurance. This information is displayed to users in an error page. -
» email string false The email with which a user can contact support. -
» phone string false The phone number with which a user can contact support. -

postOauthClients

Name Type Required Description Accepted Values
name string true The name of the OAuth client. -
redirectUri string true The callback URL where Consumer Identity Provider redirects the user after the authorization code is granted or denied. -
scopes [string] true The type of access provided to the client. read, write

OauthClient

Name Type Required Description Accepted Values
id string true The ID of the OAuth client. -
name string true The name of the OAuth client. -
redirectUri string true The callback URL where Consumer Identity Provider redirects the user after the authorization code is granted or denied. -
scopes string true The type of access provided to the client. read, write

OauthClients

Name Type Required Description Accepted Values
items [OauthClient] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putOauthClients

Name Type Required Description Accepted Values
name string true The name of the OAuth client. -
redirectUri string true The callback URL where Consumer Identity Provider redirects the user after the authorization code is granted or denied. -
scopes [string] true The type of access provided to the client. read, write

postServiceProviders

Name Type Required Description Accepted Values
name string true The name of the service provider. -
entityId string true A globally unique ID of the service provider. Cerner recommends that this value matches the URL of the service provider’s SAML metadata document. -
metadataUrl string true The URL of the service provider’s SAML metadata document. A SAML metadata document describes the service provider’s SAML deployment. -
singleLogoutEnabled boolean false Indicates whether the service provider wants to participate in SAML single logout. -
identityProvider object true The reference to the identity provider the service provider uses to authenticate. -
» id string true The ID of the identity provider. -

ServiceProvider

Name Type Required Description Accepted Values
id string true The ID of the service provider. -
name string true The name of the service provider. -
entityId string true A globally unique ID of the service provider. Cerner recommends that this value matches the URL of the service provider’s SAML metadata document. -
metadataUrl string true The URL of the service provider’s SAML metadata document. A SAML metadata document describes the service provider’s SAML deployment. -
singleLogoutEnabled boolean true Indicates whether the service provider wants to participate in SAML single logout. -
identityProvider IdentityProviderReference true The reference to the identity provider the service provider uses to authenticate. -

ServiceProviders

Name Type Required Description Accepted Values
items [ServiceProvider] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putServiceProviders

Name Type Required Description Accepted Values
name string true The name of the service provider. -
entityId string true A globally unique ID of the service provider. Cerner recommends that this value matches the URL of the service provider’s SAML metadata document. -
metadataUrl string true The URL of the service provider’s SAML metadata document. A SAML metadata document describes the service provider’s SAML deployment. -
singleLogoutEnabled boolean false Indicates whether the service provider wants to participate in SAML single logout. -
identityProvider object true The reference to the identity provider the service provider uses to authenticate. -
» id string true The ID of the identity provider. -

postSignupTokens

Name Type Required Description Accepted Values
redirectUrl string true The location where the user is redirected after the sign-up process is completed. -
emailAddress string false The email address of the user. -
firstName string false The first name of the user. -
lastName string false The last name of the user. -
dateOfBirth string false The date when the user was born in ISO 8601 complete date format. -
mobileNumber string false The mobile phone number of the user. -
gender string false The gender of the user. MALE, FEMALE, OTHER

SignupToken

Name Type Required Description Accepted Values
id string true The ID of the sign-up token. -
redirectUrl string true The location where the user is redirected after the sign-up process is completed. -
emailAddress string false The email address of the user. -
firstName string false The first name of the user. -
lastName string false The last name of the user. -
dateOfBirth string false The date when the user was born in ISO 8601 complete date format. -
mobileNumber string false The mobile phone number of the user. -
gender string false The gender of the user. MALE, FEMALE, OTHER

SignupTokens

Name Type Required Description Accepted Values
items [SignupToken] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putSignupTokens

Name Type Required Description Accepted Values
redirectUrl string true The location where the user is redirected after the sign-up process is completed. -
emailAddress string false The email address of the user. -
firstName string false The first name of the user. -
lastName string false The last name of the user. -
dateOfBirth string false The date when the user was born in ISO 8601 complete date format. -
mobileNumber string false The mobile phone number of the user. -
gender string false The gender of the user. MALE, FEMALE, OTHER

postSiteConfigs

Name Type Required Description Accepted Values
domain object true The reference to the domain where the site is hosted. -
» id string true The ID of the domain. -
identityProvider object true The reference to the identity provider to which the site configuration belongs. -
» id string true The ID of the identity provider. -
brand object true The reference to the brand of the site. -
» id string true The ID of the brand. -
banner object false The banner in which messages can be displayed in the identity provider. -
» type string true The type of the banner. This allows you to configures the appearance of the banner when it is displayed to users. The following values are allowed:
- INFO: Formats the banner as information and adds the Information. prefix.
- ERROR: Formats the banner as an error and adds the Error. prefix.
- CUSTOM: Formats the banner as help and adds the Help! prefix.
- WARNING: Formats the banner as a warning and adds the Warning. prefix.
- ADVISORY: Formats the banner as an advisory and adds the Advisory. prefix.
-
» localizedTexts [object] true A list of localized texts to display in the banner. -
»» locale string true The locale of the text. Ensure that the locale matches the ISO 639-1 specification. -
»» text string true The localized value of the text. -

SiteConfig

Name Type Required Description Accepted Values
id string true The ID of the site configuration. -
domain DomainReference true The reference to the domain where the site is hosted. -
identityProvider IdentityProviderReference true The reference to the identity provider to which the site configuration belongs. -
brand BrandReference true The reference to the brand of the site. -
createdAt string true The date and time in ISO 8601 format (with a minimum of second precision) when the resource was created, relative to its internal data storage. -
updatedAt string true The date and time in ISO 8601 format (with a minimum of second precision) when the resource was last updated, relative to its internal data storage. -
banner Banner false The banner in which messages can be displayed in the identity provider. -

DomainReference

Name Type Required Description Accepted Values
id string true The ID of the domain. -

BrandReference

Name Type Required Description Accepted Values
id string true The ID of the brand. -

Name Type Required Description Accepted Values
type string true The type of the banner. This allows you to configures the appearance of the banner when it is displayed to users. The following values are allowed:
- INFO: Formats the banner as information and adds the Information. prefix.
- ERROR: Formats the banner as an error and adds the Error. prefix.
- CUSTOM: Formats the banner as help and adds the Help! prefix.
- WARNING: Formats the banner as a warning and adds the Warning. prefix.
- ADVISORY: Formats the banner as an advisory and adds the Advisory. prefix.
INFO, ERROR, CUSTOM, WARNING, ADVISORY
localizedTexts [LocalizedText] true A list of localized texts to display in the banner. -

SiteConfigs

Name Type Required Description Accepted Values
items [SiteConfig] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putSiteConfigs

Name Type Required Description Accepted Values
domain object true The reference to the domain where the site is hosted. -
» id string true The ID of the domain. -
identityProvider object true The reference to the identity provider to which the site configuration belongs. -
» id string true The ID of the identity provider. -
brand object true The reference to the brand of the site. -
» id string true The ID of the brand. -
banner object false The banner in which messages can be displayed in the identity provider. -
» type string true The type of the banner. This allows you to configures the appearance of the banner when it is displayed to users. The following values are allowed:
- INFO: Formats the banner as information and adds the Information. prefix.
- ERROR: Formats the banner as an error and adds the Error. prefix.
- CUSTOM: Formats the banner as help and adds the Help! prefix.
- WARNING: Formats the banner as a warning and adds the Warning. prefix.
- ADVISORY: Formats the banner as an advisory and adds the Advisory. prefix.
-
» localizedTexts [object] true A list of localized texts to display in the banner. -
»» locale string true The locale of the text. Ensure that the locale matches the ISO 639-1 specification. -
»» text string true The localized value of the text. -

postUserGroups

Name Type Required Description Accepted Values
name string true The name of the user group. -
identityProviders [object] true The references to the identity providers to which the user group belongs. -
» id string true The ID of the identity provider. -
description string false The free-text description of the user group. -

UserGroup

Name Type Required Description Accepted Values
id string true The ID of the user group. -
name string true The name of the user group. -
description string false The free-text description of the user group. -
identityProviders [IdentityProviderReference] true The references to the identity providers to which the user group belongs. -

UserGroups

Name Type Required Description Accepted Values
items [UserGroup] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putUserGroups

Name Type Required Description Accepted Values
name string true The name of the user group. -
identityProviders [object] true The references to the identity providers to which the user group belongs. -
» id string true The ID of the identity provider. -
description string false The free-text description of the user group. -

postUsers

Name Type Required Description Accepted Values
emailAddress string true The email address of the user. -
userGroup object true A reference to the user group which the user belongs to. -
» id string true The ID of the user group. -
identityFabricUser object true The Identity Fabric user associated with the user. -
» id string true The ID of the Identity Fabric user that stores a Consumer Identity Provider user’s password. -
» username string true The username of the Identity Fabric user that stores a Consumer Identity Provider user’s password. -
firstName string false The first name of the user. -
lastName string false The last name of the user. -
gender string false The gender of the user. MALE, FEMALE, OTHER
dateOfBirth string false The date when the user was born in ISO 8601 complete date format. -
mobileNumber string false The mobile phone number of the user. -

User

Name Type Required Description Accepted Values
id string true The ID of the user. -
emailAddress string true The email address of the user. -
userGroup UserGroupReference true A reference to the user group which the user belongs to. -
identityFabricUser IdentityFabricUser true The Identity Fabric user associated with the user. -
firstName string false The first name of the user. -
lastName string false The last name of the user. -
gender string false The gender of the user. MALE, FEMALE, OTHER
dateOfBirth string false The date when the user was born in ISO 8601 complete date format. -
mobileNumber string false The mobile phone number of the user. -
principal string false The unique ID of the user in the cloud session identity realm. -

UserGroupReference

Name Type Required Description Accepted Values
id string true The ID of the user group. -

IdentityFabricUser

Name Type Required Description Accepted Values
id string true The ID of the Identity Fabric user that stores a Consumer Identity Provider user’s password. -
username string true The username of the Identity Fabric user that stores a Consumer Identity Provider user’s password. -

Users

Name Type Required Description Accepted Values
items [User] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putUsers

Name Type Required Description Accepted Values
emailAddress string true The email address of the user. -
userGroup object true A reference to the user group which the user belongs to. -
» id string true The ID of the user group. -
identityFabricUser object true The Identity Fabric user associated with the user. -
» id string true The ID of the Identity Fabric user that stores a Consumer Identity Provider user’s password. -
» username string true The username of the Identity Fabric user that stores a Consumer Identity Provider user’s password. -
firstName string false The first name of the user. -
lastName string false The last name of the user. -
gender string false The gender of the user. MALE, FEMALE, OTHER
dateOfBirth string false The date when the user was born in ISO 8601 complete date format. -
mobileNumber string false The mobile phone number of the user. -