Infisical Project Identity Membership API
The Project Identity Membership API from Infisical — 3 operation(s) for project identity membership.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin Project Identity Membership 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: Project Identity Membership
paths:
/api/v1/projects/{projectId}/memberships/identities/{identityId}:
get:
operationId: getProjectIdentityMembershipById
tags:
- Project Identity Membership
description: Get project identity membership by identity ID
parameters:
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project to get the identity membership for.
- schema:
type: string
in: path
name: identityId
required: true
description: The ID of the machine identity to get the membership for.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
identityMembership:
type: object
properties:
id:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
roles:
type: array
items:
type: object
properties:
id:
type: string
role:
type: string
customRoleId:
type: string
nullable: true
customRoleName:
type: string
nullable: true
customRoleSlug:
type: string
nullable: true
isTemporary:
type: boolean
temporaryMode:
type: string
nullable: true
temporaryRange:
type: string
nullable: true
temporaryAccessStartTime:
type: string
format: date-time
nullable: true
temporaryAccessEndTime:
type: string
format: date-time
nullable: true
required:
- id
- role
- isTemporary
additionalProperties: false
lastLoginAuthMethod:
type: string
nullable: true
lastLoginTime:
type: string
format: date-time
nullable: true
identity:
type: object
properties:
name:
type: string
id:
type: string
format: uuid
orgId:
type: string
format: uuid
projectId:
type: string
nullable: true
authMethods:
type: array
items:
type: string
metadata:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
key:
type: string
minLength: 1
value:
type: string
minLength: 1
required:
- id
- key
- value
additionalProperties: false
required:
- name
- id
- orgId
- authMethods
additionalProperties: false
required:
- id
- createdAt
- updatedAt
- roles
- identity
additionalProperties: false
required:
- identityMembership
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}/memberships/identities:
get:
operationId: listProjectIdentityMemberships
tags:
- Project Identity Membership
description: List project identity memberships
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 membership.
- schema:
type: number
minimum: 1
maximum: 1000
default: 20
in: query
name: limit
required: false
description: The number of identity memberships to return.
- schema:
type: string
in: query
name: identityName
required: false
description: The text string that identity membership names will be filtered by.
- schema:
type: string
in: query
name: roles
required: false
description: The role slugs to filter identity memberships by.
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project to list identity memberships from.
security:
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
identityMemberships:
type: array
items:
type: object
properties:
id:
type: string
identityId:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
roles:
type: array
items:
type: object
properties:
id:
type: string
role:
type: string
customRoleId:
type: string
nullable: true
customRoleName:
type: string
nullable: true
customRoleSlug:
type: string
nullable: true
isTemporary:
type: boolean
temporaryMode:
type: string
nullable: true
temporaryRange:
type: string
nullable: true
temporaryAccessStartTime:
type: string
format: date-time
nullable: true
temporaryAccessEndTime:
type: string
format: date-time
nullable: true
required:
- id
- role
- isTemporary
additionalProperties: false
identity:
type: object
properties:
name:
type: string
id:
type: string
format: uuid
orgId:
type: string
format: uuid
projectId:
type: string
nullable: true
authMethods:
type: array
items:
type: string
activeLockoutAuthMethods:
type: array
items:
type: string
required:
- name
- id
- orgId
- authMethods
- activeLockoutAuthMethods
additionalProperties: false
required:
- id
- identityId
- createdAt
- updatedAt
- roles
- identity
additionalProperties: false
totalCount:
type: number
required:
- identityMemberships
- 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}/memberships/available-identities:
get:
operationId: listAvailableProjectIdentities
tags:
- Project Identity Membership
description: List available identities for project membership
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: identityName
required: false
description: The text string that identity membership names will be filtered by.
- schema:
type: string
in: path
name: projectId
required: true
description: The ID of the project to list available identities for.
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
required:
- id
- name
additionalProperties: false
required:
- identities
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