openapi: 3.0.3 info: title: Infisical Admin Token Auth API description: List of all available APIs that can be consumed version: 0.0.1 servers: - url: https://us.infisical.com description: Production server (US) - url: https://eu.infisical.com description: Production server (EU) - url: http://localhost:8080 description: Local server tags: - name: Token Auth paths: /api/v1/auth/token-auth/identities/{identityId}: post: operationId: attachTokenAuth tags: - Token Auth description: Attach Token Auth configuration onto machine identity requestBody: required: true content: application/json: schema: type: object properties: accessTokenTrustedIps: type: array items: type: object properties: ipAddress: type: string required: - ipAddress additionalProperties: false minItems: 1 default: - ipAddress: 0.0.0.0/0 - ipAddress: ::/0 description: The IPs or CIDR ranges that access tokens can be used from. accessTokenTTL: type: integer minimum: 0 maximum: 315360000 default: 2592000 description: The lifetime for an access token in seconds. accessTokenMaxTTL: type: integer minimum: 0 maximum: 315360000 default: 2592000 description: The maximum lifetime for an access token in seconds. accessTokenNumUsesLimit: type: integer minimum: 0 default: 0 description: The maximum number of times that an access token can be used. additionalProperties: false parameters: - schema: type: string in: path name: identityId required: true description: The ID of the machine identity to attach the configuration onto. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: identityTokenAuth: type: object properties: id: type: string format: uuid accessTokenTTL: type: number default: 7200 accessTokenMaxTTL: type: number default: 7200 accessTokenNumUsesLimit: type: number default: 0 accessTokenTrustedIps: {} createdAt: type: string format: date-time updatedAt: type: string format: date-time identityId: type: string format: uuid accessTokenPeriod: type: number default: 0 required: - id - createdAt - updatedAt - identityId additionalProperties: false required: - identityTokenAuth additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateTokenAuth tags: - Token Auth description: Update Token Auth configuration on machine identity requestBody: required: true content: application/json: schema: type: object properties: accessTokenTrustedIps: type: array items: type: object properties: ipAddress: type: string required: - ipAddress additionalProperties: false minItems: 1 description: The new IPs or CIDR ranges that access tokens can be used from. accessTokenTTL: type: integer minimum: 0 maximum: 315360000 description: The new lifetime for an access token in seconds. accessTokenNumUsesLimit: type: integer minimum: 0 description: The new maximum number of times that an access token can be used. accessTokenMaxTTL: type: integer minimum: 0 maximum: 315360000 description: The new maximum lifetime for an access token in seconds. additionalProperties: false parameters: - schema: type: string in: path name: identityId required: true description: The ID of the machine identity to update the auth method for. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: identityTokenAuth: type: object properties: id: type: string format: uuid accessTokenTTL: type: number default: 7200 accessTokenMaxTTL: type: number default: 7200 accessTokenNumUsesLimit: type: number default: 0 accessTokenTrustedIps: {} createdAt: type: string format: date-time updatedAt: type: string format: date-time identityId: type: string format: uuid accessTokenPeriod: type: number default: 0 required: - id - createdAt - updatedAt - identityId additionalProperties: false required: - identityTokenAuth additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false get: operationId: getTokenAuth tags: - Token Auth description: Retrieve Token Auth configuration on machine identity parameters: - schema: type: string in: path name: identityId required: true description: The ID of the machine identity to retrieve the auth method for. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: identityTokenAuth: type: object properties: id: type: string format: uuid accessTokenTTL: type: number default: 7200 accessTokenMaxTTL: type: number default: 7200 accessTokenNumUsesLimit: type: number default: 0 accessTokenTrustedIps: {} createdAt: type: string format: date-time updatedAt: type: string format: date-time identityId: type: string format: uuid accessTokenPeriod: type: number default: 0 required: - id - createdAt - updatedAt - identityId additionalProperties: false required: - identityTokenAuth additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: operationId: deleteTokenAuth tags: - Token Auth description: Delete Token Auth configuration on machine identity parameters: - schema: type: string in: path name: identityId required: true description: The ID of the machine identity to revoke the auth method for. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: identityTokenAuth: type: object properties: id: type: string format: uuid accessTokenTTL: type: number default: 7200 accessTokenMaxTTL: type: number default: 7200 accessTokenNumUsesLimit: type: number default: 0 accessTokenTrustedIps: {} createdAt: type: string format: date-time updatedAt: type: string format: date-time identityId: type: string format: uuid accessTokenPeriod: type: number default: 0 required: - id - createdAt - updatedAt - identityId additionalProperties: false required: - identityTokenAuth additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/auth/token-auth/identities/{identityId}/tokens: post: operationId: createTokenAuthToken tags: - Token Auth description: Create token for machine identity with Token Auth requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the token to create. organizationSlug: type: string minLength: 1 maxLength: 64 description: The sub organization name to scope the token to. additionalProperties: false parameters: - schema: type: string in: path name: identityId required: true description: The ID of the machine identity to create the token for. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: accessToken: type: string expiresIn: type: number accessTokenMaxTTL: type: number tokenType: type: string enum: - Bearer tokenData: type: object properties: id: type: string accessTokenTTL: type: number default: 2592000 accessTokenMaxTTL: type: number default: 2592000 accessTokenNumUses: type: number default: 0 accessTokenNumUsesLimit: type: number default: 0 accessTokenLastUsedAt: type: string format: date-time nullable: true accessTokenLastRenewedAt: type: string format: date-time nullable: true isAccessTokenRevoked: type: boolean default: false identityUAClientSecretId: type: string nullable: true identityId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string nullable: true authMethod: type: string accessTokenPeriod: type: number default: 0 subOrganizationId: type: string format: uuid nullable: true required: - id - identityId - createdAt - updatedAt - authMethod additionalProperties: false required: - accessToken - expiresIn - accessTokenMaxTTL - tokenType - tokenData additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false get: operationId: getTokenAuthTokens tags: - Token Auth description: Get tokens for machine identity with Token Auth parameters: - schema: type: number minimum: 0 maximum: 100 default: 0 in: query name: offset required: false description: The offset to start from. If you enter 10, it will start from the 10th token. - schema: type: number minimum: 1 maximum: 100 default: 20 in: query name: limit required: false description: The number of tokens to return. - schema: type: string in: path name: identityId required: true description: The ID of the machine identity to list token metadata for. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: tokens: type: array items: type: object properties: id: type: string accessTokenTTL: type: number default: 2592000 accessTokenMaxTTL: type: number default: 2592000 accessTokenNumUses: type: number default: 0 accessTokenNumUsesLimit: type: number default: 0 accessTokenLastUsedAt: type: string format: date-time nullable: true accessTokenLastRenewedAt: type: string format: date-time nullable: true isAccessTokenRevoked: type: boolean default: false identityUAClientSecretId: type: string nullable: true identityId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string nullable: true authMethod: type: string accessTokenPeriod: type: number default: 0 subOrganizationId: type: string format: uuid nullable: true required: - id - identityId - createdAt - updatedAt - authMethod additionalProperties: false required: - tokens additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/auth/token-auth/tokens/{tokenId}: get: operationId: getTokenAuthTokenById tags: - Token Auth description: Get token for machine identity with Token Auth parameters: - schema: type: string in: path name: tokenId required: true description: The ID of the token to get metadata for. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: token: type: object properties: id: type: string accessTokenTTL: type: number default: 2592000 accessTokenMaxTTL: type: number default: 2592000 accessTokenNumUses: type: number default: 0 accessTokenNumUsesLimit: type: number default: 0 accessTokenLastUsedAt: type: string format: date-time nullable: true accessTokenLastRenewedAt: type: string format: date-time nullable: true isAccessTokenRevoked: type: boolean default: false identityUAClientSecretId: type: string nullable: true identityId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string nullable: true authMethod: type: string accessTokenPeriod: type: number default: 0 subOrganizationId: type: string format: uuid nullable: true required: - id - identityId - createdAt - updatedAt - authMethod additionalProperties: false required: - token additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: operationId: updateTokenAuthToken tags: - Token Auth description: Update token for machine identity with Token Auth requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the token to update to. additionalProperties: false parameters: - schema: type: string in: path name: tokenId required: true description: The ID of the token to update metadata for. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: token: type: object properties: id: type: string accessTokenTTL: type: number default: 2592000 accessTokenMaxTTL: type: number default: 2592000 accessTokenNumUses: type: number default: 0 accessTokenNumUsesLimit: type: number default: 0 accessTokenLastUsedAt: type: string format: date-time nullable: true accessTokenLastRenewedAt: type: string format: date-time nullable: true isAccessTokenRevoked: type: boolean default: false identityUAClientSecretId: type: string nullable: true identityId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string nullable: true authMethod: type: string accessTokenPeriod: type: number default: 0 subOrganizationId: type: string format: uuid nullable: true required: - id - identityId - createdAt - updatedAt - authMethod additionalProperties: false required: - token additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/auth/token-auth/tokens/{tokenId}/revoke: post: operationId: revokeTokenAuthToken tags: - Token Auth description: Revoke token for machine identity with Token Auth parameters: - schema: type: string in: path name: tokenId required: true description: The ID of the token to revoke. security: - bearerAuth: [] responses: '200': description: Default Response content: application/json: schema: type: object properties: message: type: string required: - message additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: An access token in Infisical