Skip to content

applicationKeys.md

Latest commit

 

History

History
94 lines (67 loc) · 3.76 KB

applicationKeys.md

File metadata and controls

94 lines (67 loc) · 3.76 KB

Application Keys Actions

Details on the various actions that can be performed on the Application Keys resource, including the expected parameters and the potential responses.

Contents

Get

Returns the applicationKeys for an application

result = client.application_keys.get(applicationId=my_application_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationKeys.*, or applicationKeys.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: key, status, id, creationDate, lastUpdated, name creationDate creationDate
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc desc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status, name key
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. the*key
query Advanced Application Key Query N Application key filter JSON object which overrides the filterField and filter parameters. Advanced Application Key Query Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Application Keys Collection of applicationKeys

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Post

Create a new applicationKey for an application

result = client.application_keys.post(
    applicationId=my_application_id,
    applicationKey=my_application_key)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, applicationKeys.*, or applicationKeys.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
applicationKey Application Key Post Y ApplicationKey information Application Key Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Application Key Post Response Successfully created applicationKey

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found