Skip to content

Commit cb97caa

Browse files
author
frontegg
committed
update openapi specifications
1 parent f4ad998 commit cb97caa

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

combined.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6786,7 +6786,7 @@
67866786
"post": {
67876787
"operationId": "VendorConfigController_addOrUpdateConfig",
67886788
"summary": "Update identity management configuration",
6789-
"description": "Update the identity management configuration for your environment.\n\nUse this endpoint to add or update identity management parameters by sending the desired values in the request body.\n\nRefer to the parameter documentation for the list of supported values.",
6789+
"description": "Update the identity management configuration for your environment.\n\nUse this endpoint to add or update identity management parameters by sending the desired values in the request body.\n\nRefer to the parameter documentation for the list of supported values.\n\n**Security warning:** Setting `addPermissionsToJwt` to `false` removes permission claims from the issued JWT. If your API routes rely on those claims for permission-based authorization, they may no longer be protected, and a user with no permissions could gain admin-equivalent read and write access. Only disable it if you enforce authorization by another means.",
67906790
"parameters": [],
67916791
"requestBody": {
67926792
"required": true,
@@ -21498,7 +21498,7 @@
2149821498
"post": {
2149921499
"operationId": "UserSourcesControllerV1_createSamlFederationUserSource",
2150021500
"summary": "Create SAML Federation user source",
21501-
"description": "Create a SAML federation user source.\n\nA valid environment token is required to call this endpoint. You can obtain it from the [environment authentication route](/ciam/api/vendor-service).",
21501+
"description": "Create a SAML federation user source.\n\nA valid environment token is required to call this endpoint. You can obtain it from the [environment authentication route](/ciam/api/vendor-service/other/authenticate_vendor).",
2150221502
"parameters": [],
2150321503
"requestBody": {
2150421504
"required": true,
@@ -21898,7 +21898,7 @@
2189821898
"put": {
2189921899
"operationId": "UserSourcesControllerV1_updateSamlFederationUserSource",
2190021900
"summary": "Update SAML Federation user source",
21901-
"description": "Update a SAML federation user source.\n\nA valid environment token is required to call this endpoint. You can obtain it from the [environment authentication route](/ciam/api/vendor-service).",
21901+
"description": "Update a SAML federation user source.\n\nA valid environment token is required to call this endpoint. You can obtain it from the [environment authentication route](/ciam/api/vendor-service/other/authenticate_vendor).",
2190221902
"parameters": [
2190321903
{
2190421904
"name": "id",
@@ -29943,7 +29943,8 @@
2994329943
"type": "boolean"
2994429944
},
2994529945
"addPermissionsToJwt": {
29946-
"type": "boolean"
29946+
"type": "boolean",
29947+
"description": "Controls whether permission claims are included in the issued JWT. When `true`, the user's permissions are added to the token.\n\n**Security warning:** Setting this to `false` removes the permission claims from the issued JWT. If your API routes rely on those claims for permission-based authorization, they may no longer be protected, and a user with no permissions could gain admin-equivalent read and write access. Only disable this if you enforce authorization by another means."
2994729948
},
2994829949
"allowCustomLoginTenantSwitch": {
2994929950
"type": "boolean"

identity.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1328,7 +1328,7 @@
13281328
"post": {
13291329
"operationId": "VendorConfigController_addOrUpdateConfig",
13301330
"summary": "Update identity management configuration",
1331-
"description": "Update the identity management configuration for your environment.\n\nUse this endpoint to add or update identity management parameters by sending the desired values in the request body.\n\nRefer to the parameter documentation for the list of supported values.",
1331+
"description": "Update the identity management configuration for your environment.\n\nUse this endpoint to add or update identity management parameters by sending the desired values in the request body.\n\nRefer to the parameter documentation for the list of supported values.\n\n**Security warning:** Setting `addPermissionsToJwt` to `false` removes permission claims from the issued JWT. If your API routes rely on those claims for permission-based authorization, they may no longer be protected, and a user with no permissions could gain admin-equivalent read and write access. Only disable it if you enforce authorization by another means.",
13321332
"parameters": [],
13331333
"requestBody": {
13341334
"required": true,
@@ -10268,7 +10268,7 @@
1026810268
"post": {
1026910269
"operationId": "UserSourcesControllerV1_createSamlFederationUserSource",
1027010270
"summary": "Create SAML Federation user source",
10271-
"description": "Create a SAML federation user source.\n\nA valid environment token is required to call this endpoint. You can obtain it from the [environment authentication route](/ciam/api/vendor-service).",
10271+
"description": "Create a SAML federation user source.\n\nA valid environment token is required to call this endpoint. You can obtain it from the [environment authentication route](/ciam/api/vendor-service/other/authenticate_vendor).",
1027210272
"parameters": [],
1027310273
"requestBody": {
1027410274
"required": true,
@@ -10476,7 +10476,7 @@
1047610476
"put": {
1047710477
"operationId": "UserSourcesControllerV1_updateSamlFederationUserSource",
1047810478
"summary": "Update SAML Federation user source",
10479-
"description": "Update a SAML federation user source.\n\nA valid environment token is required to call this endpoint. You can obtain it from the [environment authentication route](/ciam/api/vendor-service).",
10479+
"description": "Update a SAML federation user source.\n\nA valid environment token is required to call this endpoint. You can obtain it from the [environment authentication route](/ciam/api/vendor-service/other/authenticate_vendor).",
1048010480
"parameters": [
1048110481
{
1048210482
"name": "id",
@@ -12273,7 +12273,8 @@
1227312273
"type": "boolean"
1227412274
},
1227512275
"addPermissionsToJwt": {
12276-
"type": "boolean"
12276+
"type": "boolean",
12277+
"description": "Controls whether permission claims are included in the issued JWT. When `true`, the user's permissions are added to the token.\n\n**Security warning:** Setting this to `false` removes the permission claims from the issued JWT. If your API routes rely on those claims for permission-based authorization, they may no longer be protected, and a user with no permissions could gain admin-equivalent read and write access. Only disable this if you enforce authorization by another means."
1227712278
},
1227812279
"allowCustomLoginTenantSwitch": {
1227912280
"type": "boolean"

0 commit comments

Comments
 (0)