Skip to content

Commit f246cea

Browse files
feat: updated Polis swagger api to include ttlInMinutes config (#2416)
updated swagger api
1 parent a603e41 commit f246cea

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

docs/polis/reference/api.json

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.3",
33
"info": {
44
"title": "Enterprise SSO & Directory Sync",
5-
"version": "1.47.0",
5+
"version": "1.52.2",
66
"description": "This is the API documentation for Polis.",
77
"termsOfService": "/tos",
88
"contact": {
@@ -20,10 +20,6 @@
2020
}
2121
],
2222
"servers": [
23-
{
24-
"url": "https://api.eu.boxyhq.com",
25-
"description": "Cloud"
26-
},
2723
{
2824
"url": "http://localhost:5225",
2925
"description": "Local"
@@ -2113,19 +2109,19 @@
21132109
"id": "038e767b-9bc6-4dbd-975e-fbc38a8e7d82",
21142110
"first_name": "Deepak",
21152111
"last_name": "Prabhakara",
2116-
"email": "deepak@boxyhq.com",
2112+
"email": "deepak@example.com",
21172113
"active": true,
21182114
"raw": {
21192115
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
2120-
"userName": "deepak@boxyhq.com",
2116+
"userName": "deepak@example.com",
21212117
"name": {
21222118
"givenName": "Deepak",
21232119
"familyName": "Prabhakara"
21242120
},
21252121
"emails": [
21262122
{
21272123
"primary": true,
2128-
"value": "deepak@boxyhq.com",
2124+
"value": "deepak@example.com",
21292125
"type": "work"
21302126
}
21312127
],
@@ -2185,7 +2181,7 @@
21852181
"mappings": {
21862182
"type": "array",
21872183
"items": {
2188-
"type": "string"
2184+
"$ref": "#/components/schemas/AttributeMapping"
21892185
},
21902186
"description": "Mapping of attributes from the IdP to SP"
21912187
},
@@ -2202,6 +2198,14 @@
22022198
"type": "string"
22032199
},
22042200
"description": "If creating an OIDC app, provide the redirect URL"
2201+
},
2202+
"samlAudienceOverride": {
2203+
"type": "string",
2204+
"description": "Override the SAML Audience on a per app basis"
2205+
},
2206+
"ttlInMinutes": {
2207+
"type": "number",
2208+
"description": "Time-to-live in minutes for the SAML assertion, does not apply to OIDC flows"
22052209
}
22062210
}
22072211
},
@@ -2222,6 +2226,19 @@
22222226
}
22232227
]
22242228
},
2229+
"AttributeMapping": {
2230+
"type": "object",
2231+
"properties": {
2232+
"key": {
2233+
"type": "string",
2234+
"description": "SP attribute"
2235+
},
2236+
"value": {
2237+
"type": "string",
2238+
"description": "IdP attribute"
2239+
}
2240+
}
2241+
},
22252242
"IdentityFederationResponse": {
22262243
"type": "object",
22272244
"properties": {

0 commit comments

Comments
 (0)