Sign in

v1

latestOpenAPI 3.0.1License2026-07-17467229.7 KB
SSA

Create SSA.

Create SSA for the organization with expiration (optional).

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer {{your-access-token}}

Security: OAuth 2.0

Scopes:

  • https://jans.io/auth/ssa.admin - SSA Admin, You can create SSA.
post/restv1/ssa

Request body

org_idstring required

The org_id is used for organization identification.

descriptionstring

Description SSA.

expirationnumber

Expiration date. If this field is not sent, it will take days to expire, according to how it has been configured.

software_idstring required

The software_id is used for software identification.

software_rolesstring[] required

List of string values, fixed value ["password", "notify"].

grant_typesstring[] required

Fixed value ["client_credentials"].

one_time_useboolean required

Defined whether the SSA will be used only once or can be used multiple times.

rotate_ssaboolean required

TODO - Will be used to rotate expiration of the SSA, currently is only saved as part of the SSA.

lifetimeinteger

SSA lifetime in seconds.

Example request

{
  "description": "Your description of SSA",
  "expiration": 1660832042,
  "software_id": "gluu-scan-api",
  "software_roles": [
    "password"
  ],
  "grant_types": [
    "client_credentials"
  ],
  "lifetime": 86400
}

Response

Created

ssastring

Example response

{
  "ssa": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3BvcnRhbC5nbHV1Lm9yZyIsImlhdCI6IjE2NTUzMTkyNjgiLCJqdGkiOiJmN2I1OTkxYy00YzE4LTRjODEtYTY2NC1lNmY4NjcwZjVkNTEiLCJzb2Z0d2FyZV9pZCI6ImdsdXUtc2Nhbi1hcGkiLCJvcmdfaWQiOjEsInNvZnR3YXJlX3JvbGVzIjpbInBhc3N3dXJkIl0sImp3a3NfdXJpIjoiaHR0cHM6Ly9jbG91ZC1kZXYuZ2x1dS5jbG91ZC9wb3J0YWwvandrcyIsImdyYW50X3R5cGVzIjpbImNsaWVudF9jcmVkZW50aWFscyJdLCJleHAiOjE2NTkzMTkyNjh9.MkE-47SvBshmazBfyhAcHsqPpFIbg5CpA8k2TxDWhxc"
}