Infisical Identities API
The Identities API from Infisical — 7 operation(s) for identities.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin Identities 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: Identities
paths:
/api/v1/projects/{projectId}/identities:
post:
operationId: createProjectMachineIdentity
tags:
- Identities
description: Create an identity in a project
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
description: The name of the identity to create.
hasDeleteProtection:
type: boolean
default: false
description: Prevents deletion of the identity when enabled.
metadata:
type: array
items:
type: object
properties:
key:
type: string
minLength: 1
value:
type: string
minLength: 1
required:
- key
- value
additionalProperties: false
description: An optional array of key-value pairs to attach to the identity.
required:
- name
additionalProperties: false
parameters:
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project to create the identity in
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
identity:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
orgId:
type: string
format: uuid
projectId:
type: string
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
hasDeleteProtection:
type: boolean
default: false
activeLockoutAuthMethods:
type: array
items:
type: string
authMethods:
type: array
items:
type: string
metadata:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
id:
type: string
required:
- key
- value
- id
additionalProperties: false
required:
- id
- name
- orgId
- createdAt
- updatedAt
additionalProperties: false
required:
- identity
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: listProjectMachineIdentities
tags:
- Identities
description: List identities in a project
parameters:
- schema:
type: number
minimum: 0
default: 0
in: query
name: offset
required: false
description: The offset to start from. If you enter 10, it will start from the 10th identity.
- schema:
type: number
minimum: 1
maximum: 1000
default: 20
in: query
name: limit
required: false
description: The number of identities to return.
- schema:
type: string
in: query
name: search
required: false
description: The text string that identity names will be filtered by.
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
identities:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
orgId:
type: string
format: uuid
projectId:
type: string
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
hasDeleteProtection:
type: boolean
default: false
activeLockoutAuthMethods:
type: array
items:
type: string
authMethods:
type: array
items:
type: string
metadata:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
id:
type: string
required:
- key
- value
- id
additionalProperties: false
required:
- id
- name
- orgId
- createdAt
- updatedAt
additionalProperties: false
totalCount:
type: number
required:
- identities
- totalCount
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/projects/{projectId}/identities/{identityId}:
patch:
operationId: updateProjectMachineIdentity
tags:
- Identities
description: Update an identity in a project
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
description: The new name of the identity.
hasDeleteProtection:
type: boolean
description: Prevents deletion of the identity when enabled.
metadata:
type: array
items:
type: object
properties:
key:
type: string
minLength: 1
value:
type: string
minLength: 1
required:
- key
- value
additionalProperties: false
description: An optional array of key-value pairs to attach to the identity.
additionalProperties: false
parameters:
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project
- schema:
type: string
in: path
name: identityId
required: true
description: The ID of the machine identity to update.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
identity:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
orgId:
type: string
format: uuid
projectId:
type: string
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
hasDeleteProtection:
type: boolean
default: false
activeLockoutAuthMethods:
type: array
items:
type: string
authMethods:
type: array
items:
type: string
metadata:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
id:
type: string
required:
- key
- value
- id
additionalProperties: false
required:
- id
- name
- orgId
- createdAt
- updatedAt
additionalProperties: false
required:
- identity
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: deleteProjectMachineIdentity
tags:
- Identities
description: Delete an identity from a project
parameters:
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project
- schema:
type: string
in: path
name: identityId
required: true
description: The ID of the machine identity to delete.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
identity:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
orgId:
type: string
format: uuid
projectId:
type: string
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
hasDeleteProtection:
type: boolean
default: false
activeLockoutAuthMethods:
type: array
items:
type: string
authMethods:
type: array
items:
type: string
metadata:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
id:
type: string
required:
- key
- value
- id
additionalProperties: false
required:
- id
- name
- orgId
- createdAt
- updatedAt
additionalProperties: false
required:
- identity
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: getProjectMachineIdentityById
tags:
- Identities
description: Get an identity by ID in a project
parameters:
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project
- schema:
type: string
in: path
name: identityId
required: true
description: The ID of the machine identity to get details.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
identity:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
orgId:
type: string
format: uuid
projectId:
type: string
nullable: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
hasDeleteProtection:
type: boolean
default: false
activeLockoutAuthMethods:
type: array
items:
type: string
authMethods:
type: array
items:
type: string
metadata:
type: array
items:
type: object
properties:
key:
type: string
value:
type: string
id:
type: string
required:
- key
- value
- id
additionalProperties: false
required:
- id
- name
- orgId
- createdAt
- updatedAt
additionalProperties: false
required:
- identity
additionalProperties: false
'400':
description: Default Response
content:
application/json:
schema:
type: object
properties:
reqId:
type: string
# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-identities-api-openapi.yml