Skip to content
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

Update copy for API Key management #175809

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Update copy for API Key management #175809

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/CHANGELOG.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -980,7 +980,7 @@ Alerting::
APM::
* Adds KQL filtering in APM rules ({kibana-pull}163825[#163825]).
* Make service group saved objects exportable ({kibana-pull}163569[#163569]).
* Added ability to manage Cross-Cluster API keys ({kibana-pull}162363[#162363]).
* Added ability to manage cross-cluster API keys ({kibana-pull}162363[#162363]).
* Enable Trace Explorer by default ({kibana-pull}162308[#162308]).
* Adds error.grouping_name to group alerts in Error Count rule ({kibana-pull}161810[#161810]).
* Adds query to check for overflow bucket in service groups ({kibana-pull}159990[#159990]).
Expand Down
12 changes: 6 additions & 6 deletions docs/user/security/api-keys/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ For example, if you extract data from an {es} cluster on a daily basis, you migh

You can use {kib} to manage your different API keys:

* Personal API key: allows external services to access the Elastic Stack on behalf of a user.
* Cross-Cluster API key: allows remote clusters to connect to your local cluster.
* Managed API key: created and managed by Kibana to correctly run background tasks.
* User API key: allows external services to access the Elastic Stack on behalf of a user.
* Cross-cluster API key: allows other clusters to connect to this cluster.
* Managed API key: created and managed by Kibana to run background tasks.

To manage API keys, open the main menu, then click *Stack Management > Security > API Keys*.

Expand All @@ -24,7 +24,7 @@ image:images/api-keys.png["API Keys UI"]

* To use API keys in {kib}, you must have the `manage_security`, `manage_api_key`, or the `manage_own_api_key` cluster privileges.
* To delete API keys, you must have the `manage_api_key` or `manage_own_api_key` privileges.
* To create or update a *personal API key*, you must have the `manage_api_key` or the `manage_own_api_key` privilege.
* To create or update a *user API key*, you must have the `manage_api_key` or the `manage_own_api_key` privilege.
* To create or update a *cross-cluster API key*, you must have the `manage_security` privilege and an Enterprise license.
* To have a read-only view on the API keys, you must have access to the page and the `read_security` cluster privilege.

Expand All @@ -40,7 +40,7 @@ To create an API key, open the main menu, then click *Stack Management > Securit
image:images/create-ccr-api-key.png["Create API Key UI"]


Refer to the {ref}/security-api-create-api-key.html[create API key] documentation to learn more about creating personal API keys.
Refer to the {ref}/security-api-create-api-key.html[create API key] documentation to learn more about creating user API keys.

Refer to the {ref}/security-api-create-cross-cluster-api-key.html[create cross-cluster API key] documentation to learn more about creating cross-cluster API keys.

Expand All @@ -50,7 +50,7 @@ Refer to the {ref}/security-api-create-cross-cluster-api-key.html[create cross-c

To update an API key, open the main menu, click *Stack Management > Security > API Keys*, and then click on the name of the key. You cannot update the name or the type of API key.

Refer to the {ref}/security-api-update-api-key.html[update API key] documentation to learn more about updating personal API keys.
Refer to the {ref}/security-api-update-api-key.html[update API key] documentation to learn more about updating user API keys.

Refer to the {ref}/security-api-update-cross-cluster-api-key.html[update cross-cluster API key] documentation to learn more about updating cross-cluster API keys.

Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/security/common/model/api_key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface RestApiKey extends BaseApiKey {
}

/**
* Interface representing a Cross-Cluster API key the way it is returned by Elasticsearch GET endpoint.
* Interface representing a cross-cluster API key the way it is returned by Elasticsearch GET endpoint.
*
* TODO: Remove this type when `@elastic/elasticsearch` has been updated.
*/
Expand Down
10 changes: 5 additions & 5 deletions x-pack/plugins/security/public/management/api_keys/api_keys_grid/api_key_flyout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ export const ApiKeyFlyout: FunctionComponent<ApiKeyFlyoutProps> = ({
title={
<FormattedMessage
id="xpack.security.accountManagement.apiKeyFlyout.readonlyOwnedByOtherUserWarning"
defaultMessage="You cannot update this API key, since it is owned by another user."
defaultMessage="You can’t update this API key. It belongs to another user."
/>
}
/>
Expand All @@ -295,7 +295,7 @@ export const ApiKeyFlyout: FunctionComponent<ApiKeyFlyoutProps> = ({
title={
<FormattedMessage
id="xpack.security.accountManagement.apiKeyFlyout.readonlyExpiredWarning"
defaultMessage="You cannot update this API key, since it has already expired."
defaultMessage="This API key has expired. You can no longer update it."
/>
}
/>
Expand Down Expand Up @@ -451,7 +451,7 @@ export const ApiKeyFlyout: FunctionComponent<ApiKeyFlyoutProps> = ({
<h2>
<FormattedMessage
id="xpack.security.accountManagement.apiKeyFlyout.restTypeLabel"
defaultMessage="Personal API key"
defaultMessage="User API key"
/>
</h2>
</EuiTitle>
Expand All @@ -477,15 +477,15 @@ export const ApiKeyFlyout: FunctionComponent<ApiKeyFlyoutProps> = ({
<h2>
<FormattedMessage
id="xpack.security.accountManagement.apiKeyFlyout.crossClusterTypeLabel"
defaultMessage="Cross-Cluster API key"
defaultMessage="Cross-cluster API key"
/>
</h2>
</EuiTitle>
<EuiSpacer size="xs" />
<EuiText size="s">
<FormattedMessage
id="xpack.security.accountManagement.apiKeyFlyout.crossClusterTypeDescription"
defaultMessage="Allow remote clusters to connect to your local cluster."
defaultMessage="Allow other clusters to connect to this cluster."
/>
</EuiText>
</>
Expand Down
10 changes: 5 additions & 5 deletions x-pack/plugins/security/public/management/api_keys/api_keys_grid/api_keys_grid_page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ export const APIKeysGridPage: FunctionComponent = () => {
description={
<FormattedMessage
id="xpack.security.management.apiKeys.table.apiKeysAllDescription"
defaultMessage="Allow external services to access the Elastic Stack on behalf of a user."
defaultMessage="Allow external services to access your Elastic Stack."
/>
}
rightSideItems={
Expand Down Expand Up @@ -571,7 +571,7 @@ export const TypesFilterButton: FunctionComponent<TypesFilterButtonProps> = ({
>
<FormattedMessage
id="xpack.security.accountManagement.apiKeyBadge.restTitle"
defaultMessage="Personal"
defaultMessage="User"
/>
</EuiFilterButton>
) : null}
Expand All @@ -593,7 +593,7 @@ export const TypesFilterButton: FunctionComponent<TypesFilterButtonProps> = ({
>
<FormattedMessage
id="xpack.security.accountManagement.apiKeyBadge.crossClusterLabel"
defaultMessage="Cross-Cluster"
defaultMessage="Cross-cluster"
/>
</EuiFilterButton>
) : null}
Expand Down Expand Up @@ -786,7 +786,7 @@ export const ApiKeyBadge: FunctionComponent<ApiKeyBadgeProps> = ({ type }) => {
<EuiBadge color="hollow" iconType="cluster">
<FormattedMessage
id="xpack.security.accountManagement.apiKeyBadge.crossClusterLabel"
defaultMessage="Cross-Cluster"
defaultMessage="Cross-cluster"
/>
</EuiBadge>
</EuiToolTip>
Expand Down Expand Up @@ -818,7 +818,7 @@ export const ApiKeyBadge: FunctionComponent<ApiKeyBadgeProps> = ({ type }) => {
<EuiBadge color="hollow" iconType="user">
<FormattedMessage
id="xpack.security.accountManagement.apiKeyBadge.restTitle"
defaultMessage="Personal"
defaultMessage="User"
/>
</EuiBadge>
</EuiToolTip>
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/security/server/authentication/api_keys/api_keys.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ describe('API Keys', () => {
});
});

it('creates Cross-Cluster API key when type is `cross_cluster`', async () => {
it('creates cross-cluster API key when type is `cross_cluster`', async () => {
mockLicense.isEnabled.mockReturnValue(true);

mockScopedClusterClient.asCurrentUser.transport.request.mockResolvedValueOnce({
Expand Down Expand Up @@ -388,7 +388,7 @@ describe('API Keys', () => {
});
});

it('updates Cross-Cluster API key when type is `cross_cluster`', async () => {
it('updates cross-cluster API key when type is `cross_cluster`', async () => {
mockLicense.isEnabled.mockReturnValue(true);

mockScopedClusterClient.asCurrentUser.transport.request.mockResolvedValueOnce({
Expand Down
10 changes: 5 additions & 5 deletions x-pack/plugins/security/server/authentication/api_keys/api_keys.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ export class APIKeys implements APIKeysType {
}

/**
* Determines if Cross-Cluster API Keys are enabled in Elasticsearch.
* Determines if cross-cluster API Keys are enabled in Elasticsearch.
*/
async areCrossClusterAPIKeysEnabled(): Promise<boolean> {
if (!this.license.isEnabled()) {
Expand All @@ -123,14 +123,14 @@ export class APIKeys implements APIKeysType {
const id = 'kibana-api-key-service-test';

this.logger.debug(
`Testing if Cross-Cluster API Keys are enabled by attempting to update a non-existant key: ${id}`
`Testing if cross-cluster API Keys are enabled by attempting to update a non-existant key: ${id}`
);

try {
await this.clusterClient.asInternalUser.transport.request({
method: 'PUT',
path: `/_security/cross_cluster/api_key/${id}`,
body: {}, // We are sending an empty request body and expect a validation error if Update Cross-Cluster API key endpoint is available.
body: {}, // We are sending an empty request body and expect a validation error if Update cross-cluster API key endpoint is available.
});
return false;
} catch (error) {
Expand All @@ -143,7 +143,7 @@ export class APIKeys implements APIKeysType {
*
* Returns newly created API key or `null` if API keys are disabled.
*
* User needs `manage_api_key` privilege to create REST API keys and `manage_security` for Cross-Cluster API keys.
* User needs `manage_api_key` privilege to create REST API keys and `manage_security` for cross-cluster API keys.
*
* @param request Request instance.
* @param createParams The params to create an API key
Expand Down Expand Up @@ -199,7 +199,7 @@ export class APIKeys implements APIKeysType {
*
* Returns `updated`, `true` if the update was successful, `false` if there was nothing to update
*
* User needs `manage_api_key` privilege to update REST API keys and `manage_security` for Cross-Cluster API keys.
* User needs `manage_api_key` privilege to update REST API keys and `manage_security` for cross-cluster API keys.
*
* @param request Request instance.
* @param updateParams The params to edit an API key
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/security/server/routes/api_keys/get.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ export function defineGetApiKeysRoutes({

return response.ok<GetAPIKeysResult>({
body: {
// @ts-expect-error Elasticsearch client types do not know about Cross-Cluster API keys yet.
// @ts-expect-error Elasticsearch client types do not know about cross-cluster API keys yet.
apiKeys: validKeys,
canManageCrossClusterApiKeys:
clusterPrivileges.manage_security && areCrossClusterApiKeysEnabled,
Expand Down
Loading