> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the current user's S3 credential information

> Retrieves the S3 credential metadata for the currently logged-in user.

Adhere to the following:
- The secret key isn't returned. If you've lost it, regenerate the credential.
- Authentication requires a Keycloak token. PSK auth isn't allowed.



## OpenAPI

````yaml get /api/s3-credentials
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/s3-credentials:
    get:
      tags:
        - S3 Credentials
      summary: Get the current user's S3 credential information
      description: >-
        Retrieves the S3 credential metadata for the currently logged-in user.


        Adhere to the following:

        - The secret key isn't returned. If you've lost it, regenerate the
        credential.

        - Authentication requires a Keycloak token. PSK auth isn't allowed.
      operationId: get_s3_credential_api_s3_credentials_get
      responses:
        '200':
          description: Credential metadata retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3CredentialResponse'
        '403':
          description: Forbidden, Keycloak token required.
        '404':
          description: No S3 credential found for this user.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    S3CredentialResponse:
      properties:
        access_key:
          type: string
          title: Access Key
          description: The S3 access key ID.
        owner:
          type: string
          title: Owner
          description: The user that owns this credential.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Credential creation timestamp.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Timestamp when the credential was last regenerated.
        last_used_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Used At
          description: Timestamp when the access key was last looked up.
        is_active:
          type: boolean
          title: Is Active
          description: Whether the credential is active.
      type: object
      required:
        - access_key
        - owner
        - created_at
        - updated_at
        - is_active
      title: S3CredentialResponse
      description: Current S3 credential metadata for a user. Never includes the secret.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````