Page Comparison

Note
This is a legacy documentation page for an older version of Kantega SSO. See the latest version of the REST API documentation here: Kantega SSO Enterprise 5.7.1 REST API (latest)

Starting with version 5.2 Kantega SSO Enterprise introduces REST API for managing plugin configuration. Our plugin exposes REST resources under the /ksso/api path.

The latest Kantega SSO REST API offers the following resources:

There is a neat plugin from Atlassian for discovery and testing of REST services that you can use for running requests on your Jira installation, you can get it here:
https://marketplace.atlassian.com/apps/1211542/atlassian-rest-api-browser?hosting=server&tab=overview
You can find our APIs by searching for ksso/api and uncheck the “show only public APIs” checkbox.

...

1. General plugin information

On the resource /rest/ksso/api/info/1.0/ping, you can perform GET requests to check the liveness of Kantega SSO Enterprise.

Example

GET
https://<atlassian-product-base-url>/rest/ksso/api/info/1.0/ping

...

Code Block
{ "datetime": "2022-04-09T05:10:06.160+02:00[Europe/Oslo]", "response": "pong", "timestamp": 1649473806160 }

2. Snapshots of Config

The available services under /rest/ksso/api/snapshot are:

Resources under /rest for sysadmin	HTTP method	Description
ksso/api/snapshot/1.0/config/snapshot/	GET	Returns a list of available snapshots
ksso/api/snapshot/1.0/config/snapshot/	POST	Saves a snapshot of the Kantega SSO configuration, with optional description
ksso/api/snapshot/1.0/config/snapshot/restore/{id}	POST	Restores snapshot with id

Examples

GET
https://<atlassian-product-base-url>/rest/ksso/api/snapshot/1.0/config/snapshot/
Returns a list of available snapshots like

...

POST
/rest/ksso/api/snapshot/1.0/config/snapshot/restore/{id}
example:
/rest/ksso/api/snapshot/1.0/config/snapshot/restore/sso-snapshot-2021-12-02-19_51_50
Restores the snapshot with id sso-snapshot-2021-12-02-19_51_50. The description does not affect the id, so it’s best to retrieve the id of a snapshot with a specific description by running GET /rest/ksso/api/snapshot/1.0/config/snapshot/ and filtering the results with a specific description.

3. API Tokens

Resources under /rest/ksso/api/apitokens/2.0

Resources under /rest for sysadmin

HTTP method

Description

ksso/api/apitokens/2.0/admin/delete/{id}

DELETE

Deletes the token with the given ID. Requires system administrator access.

ksso/api/apitokens/2.0/admin/tokens

GET

Returns a list of all API tokens in the system.

Resources under /rest for user

ksso/api/apitokens/2.0/user/tokens

GET

Returns a list of all API tokens for the logged in user

ksso/api/apitokens/2.0/user/tokens

POST

Accepts a JSON body with an entry like below, or an empty JSON body where default values are generated. The default is 30 day expiry and description api_token_<ISO formatted timestamp>

Code Block

language	json

{
"tokenName":"Name"
"description":"****",
"validForDays":"180"
}

ksso/api/apitokens/2.0/user/delete/{id}

DELETE

Deletes the token with the given ID and returns plain text with a confirmation.

ksso/api/apitokens/2.0/user/expiry/status

GET

Accepts an API token ID in a query parameter as ?id Returns a JSON body with data about the expiry status for the given API token.

ksso/api/apitokens/2.0/user/refresh

PUT

Accepts a json body like below with the secret, or using the API token in the Authorization header if present and the JSON body is empty.

Code Block

language	json

{
"apiToken":"BBSVAkksjASLS****"
}

Examples

GET

rest/ksso/api/apitokens/2.0/user/tokens as an admin user

...

POST

rest/ksso/api/apitokens/12.0/user/tokens

With request body to create token with custom description and duration

Code Block

language	json

{
"tokenName": "Example name"
"description":"Longer free-text optional description about the token's purpose",
"validForDays":"180"
}

resulting in HTTP 201:

Code Block

language	json

{
  "validForDays": "180",
  "expiresAt": "2022-07-03T18:27",
  "apiToken": "YXPTJ2N52YYDDMKDHVYMQW2R7J7KMCJHQMDMUELXPKWDTR4QGRPKKS5BYTAPYAKBCMKKAMF2G3B6ATA2CVN3RWAFJX22MJEWC6QU2HTQIFJ4MVA4LOHS2ZKZ6OP3DKGR",
  "tokenName": "Example name"
  "description":"Longer free-text optional description about the token's purpose",
  "id": 67,
  "expiresAtMillis": 1656865644754
}

With empty JSON body for default values
{}

resulting in HTTP 201:

Code Block

language	json

{
  "validForDays": "30",
  "expiresAt": "2022-02-03T17:29",
  "apiToken": "UEBDRPDHDWL4UKZS6DADIKTBU2WAULTDMR2NL2M2EPTKWMES2LHGISUBP7LRZUQ5N6VAT5LHJS3ZGEI7O2AASCC5BC52RC5YDP4QI76BU4GVEGKEAMKZQ73B234O3GF7",
  "tokenName": "api_token_2022-01-04T17:29:02.042",
  "description": "",
  "id": 68,
  "expiresAtMillis": 1643905742042
}

With validForever for non-expiring token

Code Block
{ "tokenName": "Example name" "description":"Longer free-text optional description about the token's purpose", "isValidForever":true }

resulting in HTTP 201:

Code Block

{
  "apiToken": "64MVETBSHR7GFUXYCAPGPSERMOSKLLOQJHCVRXOYHWHGNUUZGUEDJFRARWCBPUZLXCNLZERXUCSB4D3H4TNSFTFY34C5IHEDILN7RXXNL6B2YVT4P7VBBE4RK7VMDZIO",
  "validForDays": "Forever",
  "tokenName": "Example name"
  "description":"Longer free-text optional description about the token's purpose",
  "id": 130,
  "expiresAt": "Never"
}

...

/rest/ksso/api/apitokens/12.0/user/expiry/status?id=65

...

Versions Compared

Old Version 5

New Version Current

Key

1. General plugin information

Example

2. Snapshots of Config

Examples

3. API Tokens

Examples