@robinmordasiewicz/f5xc-api-mcp 3.3.0 → 3.4.0

package/dist/tools/generated/authentication/index.js

@@ -0,0 +1,1005 @@
+/**
+ * Generated tool definitions for authentication domain
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
+ */
+export const authenticationTools = [
+    {
+        toolName: "f5xc-api-authentication-api-credential-create",
+        method: "POST",
+        path: "/api/web/namespaces/system/bulk_revoke/api_credentials",
+        operation: "create",
+        domain: "authentication",
+        resource: "api-credential",
+        summary: "Bulk Revoke API credentials.",
+        description: "It is used to revoke multiple API credentials. This API would disable the credentials and mark them for deletion.\nThe actual removal of objects would be done in the background.\nDepending upon if user is admin or not, following behaviour is supported:-\n* for admins : user has the access to DELETE their own as well as credentials created by others\n* for non-admins: user can only DELETE their own credentials.",
+        pathParameters: [],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialBulkRevokeResponse",
+        },
+        requiredParams: [],
+        operationId: "ves.io.schema.api_credential.CustomAPI.BulkRevoke",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            creates: ["api-credential"],
+        },
+        requiredFields: ["metadata.name", "metadata.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web api-credential create {name} --namespace {namespace}",
+                description: "Create api-credential",
+                use_case: "basic_create",
+            },
+            {
+                command: "f5xcctl web api-credential create -f {file}.yaml",
+                description: "Create from YAML file",
+                use_case: "file_based",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {},
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Api-credential resource created", "Resource assigned unique identifier"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl web api-credential create {name} --namespace {namespace}",
+                    description: "Create api-credential",
+                    use_case: "basic_create",
+                },
+                {
+                    command: "f5xcctl web api-credential create -f {file}.yaml",
+                    description: "Create from YAML file",
+                    use_case: "file_based",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "high",
+                resource_usage: "high",
+            },
+            purpose: "Create new api-credential",
+            required_fields: ["metadata.name", "metadata.namespace"],
+            side_effects: {
+                creates: ["api-credential"],
+            },
+        },
+    },
+    {
+        toolName: "f5xc-api-authentication-api-credential-get",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/api_credentials/{name}",
+        operation: "get",
+        domain: "authentication",
+        resource: "api-credential",
+        summary: "GET API Credentials.",
+        description: "GET implements API credential query by name.\nReturns API credential object. Query will look into tenants system namespace for API credential by name.",
+        pathParameters: [
+            {
+                description: "Credential name\n\nx-required\nName of API credential.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Value",
+            },
+            {
+                description: 'Namespace\n\nx-required\nValue of namespace is always "system".',
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "System",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialGetResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.api_credential.CustomAPI.Get",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.name", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web api-credential get {name} --namespace {namespace}",
+                description: "Get specific api-credential",
+                use_case: "get_specific",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            name: "Value",
+            namespace: "System",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl web api-credential get {name} --namespace {namespace}",
+                    description: "Get specific api-credential",
+                    use_case: "get_specific",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Retrieve specific api-credential",
+            required_fields: ["path.name", "path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-authentication-api-credential-list",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/api_credentials",
+        operation: "list",
+        domain: "authentication",
+        resource: "api-credential",
+        summary: "List API Credentials.",
+        description: "Returns list of API credential of all types created by the user.\nQuery will look into tenants system namespace.",
+        pathParameters: [
+            {
+                description: 'Namespace\nValue of namespace is always "system".',
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Value",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialListResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.api_credential.CustomAPI.List",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web api-credential list --namespace {namespace}",
+                description: "List all api-credentials",
+                use_case: "list_all",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            namespace: "Value",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl web api-credential list --namespace {namespace}",
+                    description: "List all api-credentials",
+                    use_case: "list_all",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all api-credentials",
+            required_fields: ["path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-authentication-scim-token-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/revoke/scim_token",
+        operation: "create",
+        domain: "authentication",
+        resource: "scim-token",
+        summary: "Revoke SCIM API credential.",
+        description: "For SCIM API credential revoke/deletion.",
+        pathParameters: [
+            {
+                description: 'Namespace\n\nx-required\nValue of namespace is always "system".',
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "System",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/api_credentialScimTokenRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialStatusResponse",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.api_credential.CustomAPI.RevokeScimToken",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            creates: ["scim-token"],
+        },
+        requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web scim-token create -f {file}.yaml",
+                description: "Create from YAML file",
+                use_case: "file_based",
+            },
+            {
+                command: "f5xcctl web scim-token create {name} --namespace {namespace}",
+                description: "Create scim-token",
+                use_case: "basic_create",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            namespace: "System",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Scim-token resource created", "Resource assigned unique identifier"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl web scim-token create {name} --namespace {namespace}",
+                    description: "Create scim-token",
+                    use_case: "basic_create",
+                },
+                {
+                    command: "f5xcctl web scim-token create -f {file}.yaml",
+                    description: "Create from YAML file",
+                    use_case: "file_based",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Create new scim-token",
+            required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
+            side_effects: {
+                creates: ["scim-token"],
+            },
+        },
+    },
+    {
+        toolName: "f5xc-api-authentication-scim-token-list",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/scim_token",
+        operation: "list",
+        domain: "authentication",
+        resource: "scim-token",
+        summary: "GET Scim Token.",
+        description: "GetScimToken implements querying of scim token.\nSCIM API token value will be visible only on create API response.\nThis detail RPC will show the current token's expiry. Returns API credential object.",
+        pathParameters: [
+            {
+                description: 'Namespace\n\nx-required\nValue of namespace is always "system".',
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "System",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialGetResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.api_credential.CustomAPI.GetScimToken",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web scim-token list --namespace {namespace}",
+                description: "List all scim-tokens",
+                use_case: "list_all",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            namespace: "System",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl web scim-token list --namespace {namespace}",
+                    description: "List all scim-tokens",
+                    use_case: "list_all",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all scim-tokens",
+            required_fields: ["path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-authentication-service-credential-create",
+        method: "POST",
+        path: "/api/web/namespaces/system/bulk_revoke/service_credentials",
+        operation: "create",
+        domain: "authentication",
+        resource: "service-credential",
+        summary: "Bulk Revoke service credential.",
+        description: "It is used to revoke multiple service credentials. This API would disable the credentials and mark them for deletion.\nThe actual removal of objects would be done in the background. Only admins are allowed to access this API.",
+        pathParameters: [],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialBulkRevokeResponse",
+        },
+        requiredParams: [],
+        operationId: "ves.io.schema.api_credential.CustomAPI.BulkRevokeServiceCredentials",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            creates: ["service-credential"],
+        },
+        requiredFields: ["metadata.name", "metadata.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web service-credential create -f {file}.yaml",
+                description: "Create from YAML file",
+                use_case: "file_based",
+            },
+            {
+                command: "f5xcctl web service-credential create {name} --namespace {namespace}",
+                description: "Create service-credential",
+                use_case: "basic_create",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {},
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [
+                    "Service-credential resource created",
+                    "Resource assigned unique identifier",
+                ],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl web service-credential create {name} --namespace {namespace}",
+                    description: "Create service-credential",
+                    use_case: "basic_create",
+                },
+                {
+                    command: "f5xcctl web service-credential create -f {file}.yaml",
+                    description: "Create from YAML file",
+                    use_case: "file_based",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "high",
+                resource_usage: "high",
+            },
+            purpose: "Create new service-credential",
+            required_fields: ["metadata.name", "metadata.namespace"],
+            side_effects: {
+                creates: ["service-credential"],
+            },
+        },
+    },
+    {
+        toolName: "f5xc-api-authentication-service-credential-get",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/service_credentials/{name}",
+        operation: "get",
+        domain: "authentication",
+        resource: "service-credential",
+        summary: "GET Service Credential.",
+        description: "GET implements service credential query by name.\nReturns service credential object. Query will look into tenants system namespace for service credential by name.",
+        pathParameters: [
+            {
+                description: "Credential name\n\nx-required\nName of API credential.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Value",
+            },
+            {
+                description: 'Namespace\n\nx-required\nValue of namespace is always "system".',
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "System",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialGetServiceCredentialsResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.api_credential.CustomAPI.GetServiceCredentials",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.name", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web service-credential get {name} --namespace {namespace}",
+                description: "Get specific service-credential",
+                use_case: "get_specific",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            name: "Value",
+            namespace: "System",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl web service-credential get {name} --namespace {namespace}",
+                    description: "Get specific service-credential",
+                    use_case: "get_specific",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Retrieve specific service-credential",
+            required_fields: ["path.name", "path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-authentication-service-credential-list",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/service_credentials",
+        operation: "list",
+        domain: "authentication",
+        resource: "service-credential",
+        summary: "List service credentials.",
+        description: "Request to list service credentials created by user.",
+        pathParameters: [
+            {
+                description: 'Namespace\nValue of namespace is always "system".',
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Value",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialListServiceCredentialsResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.api_credential.CustomAPI.ListServiceCredentials",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web service-credential list --namespace {namespace}",
+                description: "List all service-credentials",
+                use_case: "list_all",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            namespace: "Value",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl web service-credential list --namespace {namespace}",
+                    description: "List all service-credentials",
+                    use_case: "list_all",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all service-credentials",
+            required_fields: ["path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-authentication-service-credential-update",
+        method: "PUT",
+        path: "/api/web/namespaces/{namespace}/service_credentials/{name}",
+        operation: "update",
+        domain: "authentication",
+        resource: "service-credential",
+        summary: "Replace service credentials.",
+        description: "Request to replace user_groups and roles in service credentials.\nNote - for updating expiry use RenewServiceCredentials and to active/inactive service credential use ActivateServiceCredentials API.",
+        pathParameters: [
+            {
+                description: "Service Credential name\n\nx-required\nName of service credential object.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "API-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a.",
+            },
+            {
+                description: 'Namespace\nNamespace of the service credential user.\nValue of namespace is always "system".',
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "System",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/api_credentialReplaceServiceCredentialsRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/api_credentialReplaceServiceCredentialsResponse",
+        },
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.api_credential.CustomAPI.ReplaceServiceCredentials",
+        tags: ["Other"],
+        sourceFile: "domains/authentication.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            modifies: ["service-credential"],
+        },
+        requiredFields: ["path.name", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl web service-credential update {name} --namespace {namespace} -f {file}.yaml",
+                description: "Update service-credential",
+                use_case: "update",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            name: "API-cred-73c7cbd9-1342-4ce0-97a5-6c515c0b147a.",
+            namespace: "System",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Resource updated with new values"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl web service-credential update {name} --namespace {namespace} -f {file}.yaml",
+                    description: "Update service-credential",
+                    use_case: "update",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Replace existing service-credential",
+            required_fields: ["path.name", "path.namespace"],
+            side_effects: {
+                modifies: ["service-credential"],
+            },
+        },
+    },
+];
+export default authenticationTools;
+//# sourceMappingURL=index.js.map