- Products ProductsLocation Services
Solve complex location problems from geofencing to custom routing
PlatformCloud environments for location-centric solution development, data exchange and visualization
Tracking & PositioningFast and accurate tracking and positioning of people and devices, indoors or outdoors
APIs & SDKsEasy to use, scaleable and flexible tools to get going quickly
Developer EcosystemsAccess Location Services on your favorite developer platform ecosystem
- Documentation DocumentationOverview OverviewServices ServicesApplications ApplicationsDevelopment Enablers Development EnablersContent ContentHERE Studio HERE StudioHERE Workspace HERE WorkspaceHERE Marketplace HERE MarketplacePlatform Foundation and Policy Documents Platform Foundation and Policy Documents
- Pricing
- Resources ResourcesTutorials TutorialsExamples ExamplesBlog & Release Announcements Blog & Release AnnouncementsChangelog ChangelogDeveloper Newsletter Developer NewsletterKnowledge Base Knowledge BaseFeature List Feature ListSupport Plans Support PlansSystem Status System StatusLocation Services Coverage Information Location Services Coverage InformationSample Map Data for Students Sample Map Data for Students
- Help
Authentication API v1.1
This specification describes the Authentication v1.1 APIs.
More information: https://platform.here.com
Contact Info: support@here.com
Version: 1.1.x
BasePath:
Base URL:
https://account.api.here.com/authentication/v1.1
Access
Methods
[ Jump to Models ]Table of Contents
APIKeyManagement
delete /apps/{app}/apiKeys/{apiKey}post /apps/{app}/apiKeys/{apiKey}/disablepost /apps/{app}/apiKeys/{apiKey}/enablepost /apps/{app}/apiKeysget /apps/{app}/apiKeys/{apiKey}get /apps/{app}/apiKeyspatch /apps/{app}/apiKeys/{apiKey}
ApplicationAccessKeyManagement
post /apps/{app}/accessKeysdelete /apps/{app}/accessKeys/{accessKey}post /apps/{app}/accessKeys/{accessKey}/disablepost /apps/{app}/accessKeys/{accessKey}/enableget /apps/{app}/accessKeys
ApplicationManagement
APIKeyManagement
Up
delete /apps/{app}/apiKeys/{apiKey}Delete API Key (deleteAPIKey)
Deletes API key of the application. This API key can no longer be used for authentication or authorization.
Since API key cannot be recovered once deleted, it is recommended that the client application calling this end-point should enforce a confirmation of delete action (Example: Confirm box saying: Are you sure you want to delete this API Key?).
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
apiKey (required)
Path Parameter — HRN with obfuscated apiKeyId. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Responses
204
No Content401
- 401300 - Access is denied due to invalid credentials.
404
- 404660 - No app exists with the given id.
- 404666 - The API key does not exist.
429
- 429002 - Request blocked because of too many requests made. Wait for a while before making a new request.
Up
post /apps/{app}/apiKeys/{apiKey}/disableDisable API Key (disableAPIKey)
Disables API key of the application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
apiKey (required)
Path Parameter — HRN with obfuscated apiKeyId. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Responses
204
No Content401
- 401300 - Access is denied due to invalid credentials.
404
- 404660 - No app exists with the given id.
- 404666 - The API key does not exist.
429
- 429002 - Request blocked because of too many requests made. Wait for a while before making a new request.
Up
post /apps/{app}/apiKeys/{apiKey}/enableEnable API Key (enableAPIKey)
Enables API key of the application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
apiKey (required)
Path Parameter — HRN with obfuscated apiKeyId. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Responses
204
No Content401
- 401300 - Access is denied due to invalid credentials.
404
- 404660 - No app exists with the given id.
- 404666 - The API key does not exist.
429
- 429002 - Request blocked because of too many requests made. Wait for a while before making a new request.
Up
post /apps/{app}/apiKeysGenerate API Key (generateAPIKey)
Generates a new API key for the application. API key will be enabled on creation. A maximum of 2 API keys are maintained per application at any given point.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
APIKeyGenerateRequest APIKeyGenerateRequest (required)
Body Parameter —
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Return type
Example data
Content-Type: application/json
{
"apiKey" : "hrn:here:account::myrealm:apikey/ygfDVbZc7vJQTRGjC5-YXZbuwWwxFu4FxD5SsWbp-no",
"identity" : "hrn:here:account::myrealm:app/lACE8kgYxsahjbXnvy8w",
"name" : "API Key for test app",
"apiKeyId" : "2MZr9AInTFk45NAU8ClIza2Yw7w_AXyUyM4ChvtO7bY",
"createdTime" : 1545041748000,
"realm" : "hrn:here:account::myrealm:realm/myrealm",
"enabled" : true,
"expiresAt" : 1545041748000
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
201
Created ApiKey400
- 400337 - API Key cannot be generated for client with issuer(s).
401
- 401300 - Access is denied due to invalid credentials.
404
- 404660 - No app exists with the given id.
409
- 409303 - Reached allowed maximum number of active API keys per application. Delete an API key to generate another one.
429
- 429002 - Request blocked because of too many requests made. Wait for a while before making a new request.
Up
get /apps/{app}/apiKeys/{apiKey}Retrieve API Key by user (getAPIKeyByUser)
Retrieves API key of the application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
apiKey (required)
Path Parameter — HRN with obfuscated apiKeyId. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Return type
Example data
Content-Type: application/json
{
"apiKey" : "hrn:here:account::myrealm:apikey/ygfDVbZc7vJQTRGjC5-YXZbuwWwxFu4FxD5SsWbp-no",
"identity" : "hrn:here:account::myrealm:app/lACE8kgYxsahjbXnvy8w",
"name" : "API Key for test app",
"apiKeyId" : "2MZr9AInTFk45NAU8ClIza2Yw7w_AXyUyM4ChvtO7bY",
"createdTime" : 1545041748000,
"realm" : "hrn:here:account::myrealm:realm/myrealm",
"enabled" : true,
"expiresAt" : 1545041748000
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK ApiKey401
- 401300 - Access is denied due to invalid credentials.
404
- 404660 - No app exists with the given id.
- 404666 - The API key does not exist
429
- 429002 - Request blocked because of too many requests made. Wait for a while before making a new request.
Up
get /apps/{app}/apiKeysGet API Keys (getAPIKeys)
Lists the API keys generated for an application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Query parameters
pageToken (optional)
Query Parameter —
If there are more records than 'limit' (between 1 and 100), and there are multiple pages of records, 'pageToken' allows for retrieval of individual pages. In order to retrieve subsequent pages, the client should provide the pageToken returned in the result from the previous API call as input to the following API call.
Example: If the result for a call to GET /items returns {..., "pageToken": "abcdefg"}, in order to retrieve the next page of 'items' the client should call GET /items?pageToken=abcdefg
default: nulllimit (optional)
Query Parameter — Number of records to return. Default is 100 records. Maximum is 100 records. default: 100
Return type
Example data
Content-Type: application/json
nullProduces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK ApiKeyPageWToken404
- 404660 - No app exists with the given id.
429
- 429002 - Request blocked because of too many requests made. Wait for a while before making a new request.
Up
patch /apps/{app}/apiKeys/{apiKey}Update API Key (updateAPIKey)
Updates API key of the application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
apiKey (required)
Path Parameter — HRN with obfuscated apiKeyId. default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
APIKeyUpdateRequest APIKeyUpdateRequest (required)
Body Parameter —
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Return type
Example data
Content-Type: application/json
{
"apiKey" : "hrn:here:account::myrealm:apikey/ygfDVbZc7vJQTRGjC5-YXZbuwWwxFu4FxD5SsWbp-no",
"identity" : "hrn:here:account::myrealm:app/lACE8kgYxsahjbXnvy8w",
"name" : "API Key for test app",
"apiKeyId" : "2MZr9AInTFk45NAU8ClIza2Yw7w_AXyUyM4ChvtO7bY",
"createdTime" : 1545041748000,
"realm" : "hrn:here:account::myrealm:realm/myrealm",
"enabled" : true,
"expiresAt" : 1545041748000
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK ApiKey401
- 401300 - Access is denied due to invalid credentials.
404
- 404660 - No app exists with the given id.
- 404666 - The API key does not exist.
429
- 429002 - Request blocked because of too many requests made. Wait for a while before making a new request.
ApplicationAccessKeyManagement
Up
post /apps/{app}/accessKeysCreate Access Key (createAccessKey)
Create a new access key for the requested application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Return type
Example data
Content-Type: application/json
{
"accessKeyId" : "846ee567-7806-403a-97b6-6cf0b6ffa897",
"accessKeySecret" : "KuMvTQrdHVVKuMDDdcIvTQrdci1FWdcIHVVci1FW",
"clientId" : "uIkGzYShLKtQQAimXzvV",
"accessKeyHrn" : "hrn:here:account::myrealm:accesskey/846ee567-7806-403a-97b6-6cf0b6ffa897",
"clientHrn" : "hrn:here:account::myrealm:app/uIkGzYShLKtQQAimXzvV",
"createdTime" : 1545041748000,
"tokenEndpointUrl" : "https://account.api.here.com/oauth2/token",
"enabled" : true
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsontext/plain
Responses
200
OK CreateAccessKeyResponse401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse404
The requested resource was not found, see error response for details ErrorResponse Up
delete /apps/{app}/accessKeys/{accessKey}Delete Access Key (deleteAccessKey)
Delete the requested access key for the requested application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
accessKey (required)
Path Parameter — HRN identifying the access key. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
204
No Content401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse404
The requested resource was not found, see error response for details ErrorResponse Up
post /apps/{app}/accessKeys/{accessKey}/disableDisable Access Key (disableAccessKey)
Disable the requested access key for the given application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
accessKey (required)
Path Parameter — HRN identifying the access key. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
204
No Content401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse404
The requested resource was not found, see error response for details ErrorResponse Up
post /apps/{app}/accessKeys/{accessKey}/enableEnable Access Key (enableAccessKey)
Enable the requested access key for the given application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
accessKey (required)
Path Parameter — HRN identifying the access key. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
204
No Content401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse404
The requested resource was not found, see error response for details ErrorResponse Up
get /apps/{app}/accessKeysGet Access Keys (getAccessKeys)
Retrieve the list of access keys associated with the requested application.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Query parameters
limit (optional)
Query Parameter — Number of records to return. Default is 100 records. Maximum is 100 records. default: 100
pageToken (optional)
Query Parameter —
If there are more records than 'limit' (between 1 and 100), and there are multiple pages of records, 'pageToken' allows for retrieval of individual pages. In order to retrieve subsequent pages, the client should provide the pageToken returned in the result from the previous API call as input to the following API call.
Example: If the result for a call to GET /items returns {..., "pageToken": "abcdefg"}, in order to retrieve the next page of 'items' the client should call GET /items?pageToken=abcdefg
default: nullReturn type
Example data
Content-Type: application/json
nullProduces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK AccessKeyPageWithToken401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse404
The requested resource was not found, see error response for details ErrorResponseApplicationManagement
Up
post /appsCreate Application (createApplication)
Creates a new application.
- The application will be created in the same realm the calling identity belongs to. This information is obtained from the Access Token.
- The identity creating the app will be granted permission to 'manage' and delegate application management ('share').
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
CreateAppRequest CreateAppRequest (required)
Body Parameter —
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Return type
Example data
Content-Type: application/json
{
"hrn" : "hrn:here:account::myrealm:app/0123456789ABCDEFGHHIJKLM",
"name" : "Some Application",
"description" : "Application for doing something.",
"createdTime" : 1432216394712,
"realm" : "myrealm",
"id" : "0123456789ABCDEFGHHIJKLM",
"status" : "active"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK AppInfo400
Invalid input provided, see error response for details ErrorResponse401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse Up
delete /apps/{app}Delete Application (deleteApplication)
Delete the application identified by the provided hrn.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
204
No Content401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse404
The requested resource was not found, see error response for details ErrorResponse Up
get /apps/{app}Get Application (getApplication)
Retrieve the application identified by the provided hrn.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Return type
Example data
Content-Type: application/json
{
"hrn" : "hrn:here:account::myrealm:app/0123456789ABCDEFGHHIJKLM",
"name" : "Some Application",
"description" : "Application for doing something.",
"createdTime" : 1432216394712,
"realm" : "myrealm",
"id" : "0123456789ABCDEFGHHIJKLM",
"status" : "active"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK AppInfo401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse404
The requested resource was not found, see error response for details ErrorResponse Up
get /appsGet Applications (listApplications)
List applications managed by the caller.
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Query parameters
limit (optional)
Query Parameter — Number of records to return. Default is 100 records. Maximum is 100 records. default: 100
pageToken (optional)
Query Parameter —
If there are more records than 'limit' (between 1 and 100), and there are multiple pages of records, 'pageToken' allows for retrieval of individual pages. In order to retrieve subsequent pages, the client should provide the pageToken returned in the result from the previous API call as input to the following API call.
Example: If the result for a call to GET /items returns {..., "pageToken": "abcdefg"}, in order to retrieve the next page of 'items' the client should call GET /items?pageToken=abcdefg
default: nullReturn type
Example data
Content-Type: application/json
nullProduces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK AppPageWithToken401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse Up
patch /apps/{app}Update Application (updateApplication)
Update the application identified by the provided hrn.
Path parameters
app (required)
Path Parameter — HRN identifying the application. default: null
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
PatchAppRequest PatchAppRequest (required)
Body Parameter —
Request headers
Authorization (required)
Header Parameter — The OAuth2 bearer token used to authorize the request. The token should be supplied in the format 'Bearer [token]'. Access token can be obtained via Get Access Token API default: null
X-Correlation-ID (optional)
Header Parameter — Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response. default: null
X-Request-ID (optional)
Header Parameter — The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services. default: null
Return type
Example data
Content-Type: application/json
{
"hrn" : "hrn:here:account::myrealm:app/0123456789ABCDEFGHHIJKLM",
"name" : "Some Application",
"description" : "Application for doing something.",
"createdTime" : 1432216394712,
"realm" : "myrealm",
"id" : "0123456789ABCDEFGHHIJKLM",
"status" : "active"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
OK AppInfo400
Invalid input provided, see error response for details ErrorResponse401
Access is denied due to invalid credentials ErrorResponse403
You do not have permission to perform this action ErrorResponse404
The requested resource was not found, see error response for details ErrorResponseModels
[ Jump to Methods ]Table of Contents
APIKeyGenerateRequest-APIKeyUpdateRequest-AccessKey-AccessKeyPageWithToken-AccessKeyPageWithToken_allOf-ApiKey-ApiKeyPageWToken-ApiKeyPageWToken_allOf-AppInfo-AppPageWithToken-AppPageWithToken_allOf-CreateAccessKeyResponse-CreateAppRequest-ErrorDetail-ErrorResponse-PageWithToken-PatchAppRequest-Status-
APIKeyGenerateRequest - Up
name
String Creator-defined name or short description for the API key.
expiresAt (optional)
Long Timestamp (milliseconds since the Unix epoch) of when the API key will expire. If expiresAt is not provided on creation, it will default to '-1', i.e. API key does NOT expire format: int64
enabled (optional)
Boolean Whether API key is enabled or disabled.
AccessKey - Up
AccessKeyPageWithToken - Up
limit
Integer number of entries in the response.
pageToken (optional)
String The cursor for pagination. Present only if there is an additional page of data to view.
total
Integer The number of federations matching the search criteria.
items
array[AccessKey] List of access keys.
AccessKeyPageWithToken_allOf - Up
items (optional)
array[AccessKey] List of access keys.
ApiKey - Up
apiKeyId (optional)
String Plaintext query string argument used to authenticate requests to HERE Services using this API Key.
apiKey (optional)
String HRN with obfuscated apiKeyId.
identity (optional)
String HRN identifying an identity to which this API key associated with.
realm (optional)
String The HRN of the realm of API key.
name (optional)
String Creator-defined name or short description for the API key.
enabled (optional)
Boolean Whether API key is enabled or disabled.
createdTime (optional)
Long Timestamp (milliseconds since the Unix epoch) of when the API key was created. format: int64
expiresAt (optional)
Long Timestamp (milliseconds since the Unix epoch) of when the API key will expire. If expiresAt is not provided on creation, it will default to '-1', i.e. API key does NOT expire format: int64
ApiKeyPageWToken - Up
ApiKeyPageWToken_allOf - Up
items (optional)
AppInfo - Up
id (optional)
String Identifier for the client/application.
hrn (optional)
String HRN for the client/application.
realm (optional)
String The realm to which the app belongs.
name (optional)
String Human readable name of the client.
description (optional)
String Prose description of the client.
status (optional)
String Status of the client.
createdTime (optional)
Long Timestamp (milliseconds since the Unix epoch) of when the app was created. format: int64
AppPageWithToken - Up
limit
Integer number of entries in the response.
pageToken (optional)
String The cursor for pagination. Present only if there is an additional page of data to view.
total
Integer The number of federations matching the search criteria.
items
array[AppInfo] List of apps.
AppPageWithToken_allOf - Up
items (optional)
array[AppInfo] List of apps.
CreateAppRequest - Up
name
String Human readable name of the client. This field is required unless a clientId is provided.
description (optional)
String Prose description of the client
tokenDuration (optional)
Integer Default duration in seconds for the token issued to this application. It has be a non-zero value, less than or equal to 24 hours (86400) or the max allowed for the realm via the realm setting.
ErrorDetail - Up
ErrorResponse - Up
title
String Error title
errorId
String Unique id for the error. This is searchable from HERE Account logs.
status
Integer HTTP Status Code
code
String Service specific error code
cause
String The cause of the error
action
String Actionable instructions for the API consumer
correlationId (optional)
String Trace ID associated with this request, for future use
details (optional)
array[ErrorDetail] Collection of error details
PatchAppRequest - Up
name
String Human readable name of the client. This field is required unless a clientId is provided.
description (optional)
String Prose description of the client
tokenDuration (optional)
Integer Default duration in seconds for the token issued to this application. It has be a non-zero value, less than or equal to 24 hours (86400) or the max allowed for the realm via the realm setting.
