Skip to content

invalidate token public APIs #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
podishetti-nagavenu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

invalidate token public APIs #317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions api-spec/openapiSpecv3-2_0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,14 @@
],
"description": "Roles for version 9.9.0.cl"
},
{
"name": "26.2.0.cl",
"id": "26.2.0.cl",
"tags": [
"26.2.0.cl"
],
"description": "Roles for version 26.2.0.cl"
},
{
"name": "9.6.0.cl",
"id": "9.6.0.cl",
Expand Down Expand Up @@ -2834,6 +2842,109 @@
}
}
},
"/api/rest/2.0/connections/refresh-tokens/revoke": {
"post": {
"operationId": "invalidateConnectionTokens",
"description": "\n <span class=\"since-beta-tag\">Version: 26.2.0.cl or later</span>\n\nUser should have Administrative Privilege or be the Connection Author to Invalidates the refresh tokens.\n\n## Token Invalidation Rules\n\nYou can specify different combinations of identifiers to control\nwhich refresh tokens are invalidated:\n\n- **connection_identifier only**: All user's refresh tokens will be\n deleted except the connection author.\n- **connection_identifier + user_identifiers**: Only specified user's\n refresh tokens will be deleted. If the author's user_identifier is\n included, their token will also be invalidated.\n- **connection_identifier + configuration_identifiers**: Refresh\n tokens for the specified configurations will be deleted.\n- **connection_identifier + org_identifiers**: Refresh tokens for the\n specified orgs will be deleted. This is only applicable for published\n connections.\n\n**Note**: The `org_identifiers` field is only applicable for published connections. Using this field with unpublished connections will result in an error: \"The 'org_identifiers' field is only applicable for published connections. Please ensure the connection is published before including this field.\"\n\nAfter tokens are invalidated, logged-in users will need to re-authenticate to access visualizations.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Connections",
"26.2.0.cl"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"connection_identifier": {
"description": "Unique ID or name of the connection whose token needs to be deleted. All the users associated with the connection will have their tokens deleted except the author.",
"type": "string"
},
"configuration_identifiers": {
"description": "Unique ID or name of configurations. If provided, the specified configuration's user tokens will be deleted.",
"type": "array",
"items": {
"type": "string"
}
},
"user_identifiers": {
"description": "Unique ID or name of users. If provided, only the specified user's refresh tokens will be deleted. If the author's user_identifier is included, their token will also be deleted.",
"type": "array",
"items": {
"type": "string"
}
},
"org_identifiers": {
"description": "Unique ID or name of orgs. This is applicable only for published connections. If provided, the specified org's user tokens will be deleted. This field is only valid for published connections; using it with unpublished connections will return an error.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"connection_identifier"
]
}
}
},
"required": true
},
"parameters": [],
"responses": {
"200": {
"description": "Token(s) successfully revoked.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidateConnectionTokensResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden access.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/rest/2.0/connection/search": {
"post": {
"operationId": "searchConnection",
Expand Down Expand Up @@ -22269,6 +22380,18 @@
}
}
},
"InvalidateConnectionTokensResponse": {
"type": "object",
"required": [
"revoke_result"
],
"properties": {
"revoke_result": {
"type": "string",
"description": "Result message describing the outcome of the token revocation operation."
}
}
},
"RoleResponse": {
"type": "object",
"required": [
Expand Down