{ "openapi": "3.0.3", "info": { "title": "BackendService API", "version": "0.0.1" }, "paths": { "/v1/api-key-role-assignments": { "get": { "tags": [ "BackendService" ], "operationId": "BackendService_ListAPIKeyRoleAssignments", "parameters": [ { "name": "apiKeyId", "in": "query", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAPIKeyRoleAssignmentsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Key Role Assignments", "x-fern-sdk-method-name": "ListAPIKeyRoleAssignments", "summary": "List API Key Role Assignments" }, "post": { "tags": [ "BackendService" ], "operationId": "BackendService_CreateAPIKeyRoleAssignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKeyRoleAssignmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKeyRoleAssignmentResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Key Role Assignments", "x-fern-sdk-method-name": "CreateAPIKeyRoleAssignment", "summary": "Create API Key Role Assignment" } }, "/v1/api-key-role-assignments/{id}": { "delete": { "tags": [ "BackendService" ], "operationId": "BackendService_DeleteAPIKeyRoleAssignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "apiKeyId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAPIKeyRoleAssignmentResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Key Role Assignments", "x-fern-sdk-method-name": "DeleteAPIKeyRoleAssignment", "summary": "Delete API Key Role Assignment" } }, "/v1/api-keys": { "get": { "tags": [ "BackendService" ], "description": "List API Keys.", "operationId": "BackendService_ListAPIKeys", "parameters": [ { "name": "organizationId", "in": "query", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAPIKeysResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Keys", "x-fern-sdk-method-name": "ListAPIKeys", "summary": "List API Keys" }, "post": { "tags": [ "BackendService" ], "description": "Create an API Key for an Organization.", "operationId": "BackendService_CreateAPIKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Keys", "x-fern-sdk-method-name": "CreateAPIKey", "summary": "Create API Key" } }, "/v1/api-keys/authenticate": { "post": { "tags": [ "BackendService" ], "operationId": "BackendService_AuthenticateAPIKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateAPIKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Keys", "x-fern-sdk-method-name": "AuthenticateAPIKey", "summary": "Authenticate API Key" } }, "/v1/api-keys/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get an API Key.", "operationId": "BackendService_GetAPIKey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Keys", "x-fern-sdk-method-name": "GetAPIKey", "summary": "Get API Key" }, "delete": { "tags": [ "BackendService" ], "description": "Delete an API Key.", "operationId": "BackendService_DeleteAPIKey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Keys", "x-fern-sdk-method-name": "DeleteAPIKey", "summary": "Delete API Key" }, "patch": { "tags": [ "BackendService" ], "description": "Update an API Key.", "operationId": "BackendService_UpdateAPIKey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAPIKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Keys", "x-fern-sdk-method-name": "UpdateAPIKey", "summary": "Update API Key" } }, "/v1/api-keys/{id}/revoke": { "post": { "tags": [ "BackendService" ], "description": "Revoke an API Key.", "operationId": "BackendService_RevokeAPIKey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "API Keys", "x-fern-sdk-method-name": "RevokeAPIKey", "summary": "Revoke API Key" } }, "/v1/audit-log-events": { "post": { "tags": [ "BackendService" ], "operationId": "BackendService_CreateAuditLogEvent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogEvent" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAuditLogEventResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Audit Log Events", "x-fern-sdk-method-name": "CreateAuditLogEvent", "summary": "Create Audit Log Event" } }, "/v1/oidc-connections": { "get": { "tags": [ "BackendService" ], "description": "List OIDC Connections.", "operationId": "BackendService_ListOIDCConnections", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Organization ID.", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "description": "A pagination token. Leave empty to get the first page of results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOIDCConnectionsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "OIDC Connections", "x-fern-sdk-method-name": "ListOIDCConnections", "summary": "List OIDC Connections" }, "post": { "tags": [ "BackendService" ], "description": "Create an OIDC Connection.", "operationId": "BackendService_CreateOIDCConnection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OIDCConnection" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOIDCConnectionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "OIDC Connections", "x-fern-sdk-method-name": "CreateOIDCConnection", "summary": "Create OIDC Connection" } }, "/v1/oidc-connections/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get an OIDC Connection.", "operationId": "BackendService_GetOIDCConnection", "parameters": [ { "name": "id", "in": "path", "description": "The OIDC Connection ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOIDCConnectionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "OIDC Connections", "x-fern-sdk-method-name": "GetOIDCConnection", "summary": "Get OIDC Connection" }, "delete": { "tags": [ "BackendService" ], "description": "Delete an OIDC Connection.", "operationId": "BackendService_DeleteOIDCConnection", "parameters": [ { "name": "id", "in": "path", "description": "The OIDC Connection ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOIDCConnectionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "OIDC Connections", "x-fern-sdk-method-name": "DeleteOIDCConnection", "summary": "Delete OIDC Connection" }, "patch": { "tags": [ "BackendService" ], "description": "Update an OIDC Connection.", "operationId": "BackendService_UpdateOIDCConnection", "parameters": [ { "name": "id", "in": "path", "description": "The OIDC Connection ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OIDCConnection" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOIDCConnectionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "OIDC Connections", "x-fern-sdk-method-name": "UpdateOIDCConnection", "summary": "Update OIDC Connection" } }, "/v1/organizations": { "get": { "tags": [ "BackendService" ], "description": "List Organizations.", "operationId": "BackendService_ListOrganizations", "parameters": [ { "name": "pageToken", "in": "query", "description": "A pagination token. Leave empty to get the first page of results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "ListOrganizations", "summary": "List Organizations" }, "post": { "tags": [ "BackendService" ], "description": "Create an Organization.", "operationId": "BackendService_CreateOrganization", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "CreateOrganization", "summary": "Create Organization" } }, "/v1/organizations/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get an Organization.", "operationId": "BackendService_GetOrganization", "parameters": [ { "name": "id", "in": "path", "description": "The Organization ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "GetOrganization", "summary": "Get Organization" }, "delete": { "tags": [ "BackendService" ], "description": "Delete an Organization.", "operationId": "BackendService_DeleteOrganization", "parameters": [ { "name": "id", "in": "path", "description": "The Organization ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "DeleteOrganization", "summary": "Delete Organization" }, "patch": { "tags": [ "BackendService" ], "description": "Update an Organization.", "operationId": "BackendService_UpdateOrganization", "parameters": [ { "name": "id", "in": "path", "description": "The Organization ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "UpdateOrganization", "summary": "Update Organization" } }, "/v1/organizations/{organizationId}/domains": { "get": { "tags": [ "BackendService" ], "description": "Get Organization Domains.", "operationId": "BackendService_GetOrganizationDomains", "parameters": [ { "name": "organizationId", "in": "path", "description": "The Organization ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationDomainsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "GetOrganizationDomains", "summary": "Get Organization Domains" }, "patch": { "tags": [ "BackendService" ], "description": "Update Organization Domains.", "operationId": "BackendService_UpdateOrganizationDomains", "parameters": [ { "name": "organizationId", "in": "path", "description": "The Organization ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDomains" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationDomainsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "UpdateOrganizationDomains", "summary": "Update Organization Domains" } }, "/v1/organizations/{organizationId}/google-hosted-domains": { "get": { "tags": [ "BackendService" ], "description": "Get Organization Google Hosted Domains.", "operationId": "BackendService_GetOrganizationGoogleHostedDomains", "parameters": [ { "name": "organizationId", "in": "path", "description": "The ID of the Organization.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationGoogleHostedDomainsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "GetOrganizationGoogleHostedDomains", "summary": "Get Organization Google Hosted Domains" }, "patch": { "tags": [ "BackendService" ], "description": "Update Organization Google Hosted Domains.", "operationId": "BackendService_UpdateOrganizationGoogleHostedDomains", "parameters": [ { "name": "organizationId", "in": "path", "description": "The ID of the Organization.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationGoogleHostedDomains" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationGoogleHostedDomainsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "UpdateOrganizationGoogleHostedDomains", "summary": "Update Organization Google Hosted Domains" } }, "/v1/organizations/{organizationId}/microsoft-tenant-ids": { "get": { "tags": [ "BackendService" ], "description": "Get Organization Microsoft Tenant IDs.", "operationId": "BackendService_GetOrganizationMicrosoftTenantIDs", "parameters": [ { "name": "organizationId", "in": "path", "description": "The ID of the Organization.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationMicrosoftTenantIDsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "GetOrganizationMicrosoftTenantIDs", "summary": "Get Organization Microsoft Tenant IDs" }, "patch": { "tags": [ "BackendService" ], "description": "Update Organization Microsoft Tenant IDs.", "operationId": "BackendService_UpdateOrganizationMicrosoftTenantIDs", "parameters": [ { "name": "organizationId", "in": "path", "description": "The ID of the Organization.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationMicrosoftTenantIDs" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationMicrosoftTenantIDsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Organizations", "x-fern-sdk-method-name": "UpdateOrganizationMicrosoftTenantIDs", "summary": "Update Organization Microsoft Tenant IDs" } }, "/v1/passkeys": { "get": { "tags": [ "BackendService" ], "description": "List Passkeys.", "operationId": "BackendService_ListPasskeys", "parameters": [ { "name": "userId", "in": "query", "description": "The ID of the User.", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "description": "A pagination token. Leave empty to get the first page of results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPasskeysResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Passkeys", "x-fern-sdk-method-name": "ListPasskeys", "summary": "List Passkeys" } }, "/v1/passkeys/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get a Passkey.", "operationId": "BackendService_GetPasskey", "parameters": [ { "name": "id", "in": "path", "description": "The Passkey ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPasskeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Passkeys", "x-fern-sdk-method-name": "GetPasskey", "summary": "Get Passkey" }, "delete": { "tags": [ "BackendService" ], "description": "Delete a Passkey.", "operationId": "BackendService_DeletePasskey", "parameters": [ { "name": "id", "in": "path", "description": "The Passkey ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePasskeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Passkeys", "x-fern-sdk-method-name": "DeletePasskey", "summary": "Delete Passkey" }, "patch": { "tags": [ "BackendService" ], "description": "Update a Passkey.", "operationId": "BackendService_UpdatePasskey", "parameters": [ { "name": "id", "in": "path", "description": "The Passkey ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Passkey" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePasskeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Passkeys", "x-fern-sdk-method-name": "UpdatePasskey", "summary": "Update Passkey" } }, "/v1/project": { "get": { "tags": [ "BackendService" ], "description": "Get the current project.", "operationId": "BackendService_GetProject", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Projects", "x-fern-sdk-method-name": "GetProject", "summary": "Get Project" } }, "/v1/roles": { "get": { "tags": [ "BackendService" ], "description": "List Roles.", "operationId": "BackendService_ListRoles", "parameters": [ { "name": "organizationId", "in": "query", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRolesResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Roles", "x-fern-sdk-method-name": "ListRoles", "summary": "List Roles" }, "post": { "tags": [ "BackendService" ], "description": "Create a Role.", "operationId": "BackendService_CreateRole", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRoleResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Roles", "x-fern-sdk-method-name": "CreateRole", "summary": "Create Role" } }, "/v1/roles/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get a Role.", "operationId": "BackendService_GetRole", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRoleResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Roles", "x-fern-sdk-method-name": "GetRole", "summary": "Get Role" }, "delete": { "tags": [ "BackendService" ], "description": "Delete a Role.", "operationId": "BackendService_DeleteRole", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRoleResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Roles", "x-fern-sdk-method-name": "DeleteRole", "summary": "Delete Role" }, "patch": { "tags": [ "BackendService" ], "description": "Update a Role.", "operationId": "BackendService_UpdateRole", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRoleResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Roles", "x-fern-sdk-method-name": "UpdateRole", "summary": "Update Role" } }, "/v1/saml-connections": { "get": { "tags": [ "BackendService" ], "description": "List SAML Connections.", "operationId": "BackendService_ListSAMLConnections", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Organization ID.", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "description": "A pagination token. Leave empty to get the first page of results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSAMLConnectionsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SAML Connections", "x-fern-sdk-method-name": "ListSAMLConnections", "summary": "List SAML Connections" }, "post": { "tags": [ "BackendService" ], "description": "Create a SAML Connection.", "operationId": "BackendService_CreateSAMLConnection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SAMLConnection" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSAMLConnectionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SAML Connections", "x-fern-sdk-method-name": "CreateSAMLConnection", "summary": "Create SAML Connection" } }, "/v1/saml-connections/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get a SAML Connection.", "operationId": "BackendService_GetSAMLConnection", "parameters": [ { "name": "id", "in": "path", "description": "The SAML Connection ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSAMLConnectionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SAML Connections", "x-fern-sdk-method-name": "GetSAMLConnection", "summary": "Get SAML Connection" }, "delete": { "tags": [ "BackendService" ], "description": "Delete a SAML Connection.", "operationId": "BackendService_DeleteSAMLConnection", "parameters": [ { "name": "id", "in": "path", "description": "The SAML Connection ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSAMLConnectionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SAML Connections", "x-fern-sdk-method-name": "DeleteSAMLConnection", "summary": "Delete SAML Connection" }, "patch": { "tags": [ "BackendService" ], "description": "Update a SAML Connection.", "operationId": "BackendService_UpdateSAMLConnection", "parameters": [ { "name": "id", "in": "path", "description": "The SAML Connection ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SAMLConnection" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSAMLConnectionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SAML Connections", "x-fern-sdk-method-name": "UpdateSAMLConnection", "summary": "Update SAML Connection" } }, "/v1/scim-api-keys": { "get": { "tags": [ "BackendService" ], "description": "List SCIM API Keys.", "operationId": "BackendService_ListSCIMAPIKeys", "parameters": [ { "name": "organizationId", "in": "query", "description": "The ID of the Organization.", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "description": "A pagination token. Leave empty to get the first page of results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSCIMAPIKeysResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SCIM API Keys", "x-fern-sdk-method-name": "ListSCIMAPIKeys", "summary": "List SCIM API Keys" }, "post": { "tags": [ "BackendService" ], "description": "Create a SCIM API Key.", "operationId": "BackendService_CreateSCIMAPIKey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMAPIKey" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSCIMAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SCIM API Keys", "x-fern-sdk-method-name": "CreateSCIMAPIKey", "summary": "Create SCIM API Key" } }, "/v1/scim-api-keys/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get a SCIM API Key.", "operationId": "BackendService_GetSCIMAPIKey", "parameters": [ { "name": "id", "in": "path", "description": "The SCIM API Key ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSCIMAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SCIM API Keys", "x-fern-sdk-method-name": "GetSCIMAPIKey", "summary": "Get SCIM API Key" }, "delete": { "tags": [ "BackendService" ], "description": "Delete a SCIM API Key.", "operationId": "BackendService_DeleteSCIMAPIKey", "parameters": [ { "name": "id", "in": "path", "description": "The SCIM API Key ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSCIMAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SCIM API Keys", "x-fern-sdk-method-name": "DeleteSCIMAPIKey", "summary": "Delete SCIM API Key" }, "patch": { "tags": [ "BackendService" ], "description": "Update a SCIM API Key.", "operationId": "BackendService_UpdateSCIMAPIKey", "parameters": [ { "name": "id", "in": "path", "description": "The SCIM API Key ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCIMAPIKey" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSCIMAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SCIM API Keys", "x-fern-sdk-method-name": "UpdateSCIMAPIKey", "summary": "Update SCIM API Key" } }, "/v1/scim-api-keys/{id}/revoke": { "post": { "tags": [ "BackendService" ], "description": "Revoke a SCIM API Key.", "operationId": "BackendService_RevokeSCIMAPIKey", "parameters": [ { "name": "id", "in": "path", "description": "The SCIM API Key ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeSCIMAPIKeyResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "SCIM API Keys", "x-fern-sdk-method-name": "RevokeSCIMAPIKey", "summary": "Revoke SCIM API Key" } }, "/v1/sessions": { "get": { "tags": [ "BackendService" ], "description": "List Sessions.", "operationId": "BackendService_ListSessions", "parameters": [ { "name": "userId", "in": "query", "description": "The User ID.", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "description": "A pagination token. Leave empty to get the first page of results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Sessions", "x-fern-sdk-method-name": "ListSessions", "summary": "List Sessions" } }, "/v1/sessions/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get a Session.", "operationId": "BackendService_GetSession", "parameters": [ { "name": "id", "in": "path", "description": "The Session ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSessionResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Sessions", "x-fern-sdk-method-name": "GetSession", "summary": "Get Session" } }, "/v1/user-invites": { "get": { "tags": [ "BackendService" ], "description": "List User Invites.", "operationId": "BackendService_ListUserInvites", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Organization ID.", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "description": "A pagination token. Leave empty to get the first page of results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUserInvitesResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "User Invites", "x-fern-sdk-method-name": "ListUserInvites", "summary": "List User Invites" }, "post": { "tags": [ "BackendService" ], "description": "Create a User Invite.", "operationId": "BackendService_CreateUserInvite", "parameters": [ { "name": "sendEmail", "in": "query", "description": "Whether to send an email automatically as part of the invite.", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserInviteResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "User Invites", "x-fern-sdk-method-name": "CreateUserInvite", "summary": "Create User Invite" } }, "/v1/user-invites/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get a User Invite.", "operationId": "BackendService_GetUserInvite", "parameters": [ { "name": "id", "in": "path", "description": "The User Invite ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserInviteResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "User Invites", "x-fern-sdk-method-name": "GetUserInvite", "summary": "Get User Invite" }, "delete": { "tags": [ "BackendService" ], "description": "Delete a User Invite.", "operationId": "BackendService_DeleteUserInvite", "parameters": [ { "name": "id", "in": "path", "description": "The User Invite ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteUserInviteResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "User Invites", "x-fern-sdk-method-name": "DeleteUserInvite", "summary": "Delete User Invite" } }, "/v1/user-role-assignments": { "get": { "tags": [ "BackendService" ], "description": "List User Role Assignments.", "operationId": "BackendService_ListUserRoleAssignments", "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "roleId", "in": "query", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUserRoleAssignmentsResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "User Role Assignments", "x-fern-sdk-method-name": "ListUserRoleAssignments", "summary": "List User Role Assignments" }, "post": { "tags": [ "BackendService" ], "description": "Create a User Role Assignment.", "operationId": "BackendService_CreateUserRoleAssignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRoleAssignment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRoleAssignmentResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "User Role Assignments", "x-fern-sdk-method-name": "CreateUserRoleAssignment", "summary": "Create User Role Assignment" } }, "/v1/user-role-assignments/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get a User Role Assignment.", "operationId": "BackendService_GetUserRoleAssignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserRoleAssignmentResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "User Role Assignments", "x-fern-sdk-method-name": "GetUserRoleAssignment", "summary": "Get User Role Assignment" }, "delete": { "tags": [ "BackendService" ], "description": "Delete a User Role Assignment.", "operationId": "BackendService_DeleteUserRoleAssignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteUserRoleAssignmentResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "User Role Assignments", "x-fern-sdk-method-name": "DeleteUserRoleAssignment", "summary": "Delete User Role Assignment" } }, "/v1/users": { "get": { "tags": [ "BackendService" ], "description": "List Users.", "operationId": "BackendService_ListUsers", "parameters": [ { "name": "organizationId", "in": "query", "description": "The Organization ID.", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "description": "A pagination token. Leave empty to get the first page of results.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Users", "x-fern-sdk-method-name": "ListUsers", "summary": "List Users" }, "post": { "tags": [ "BackendService" ], "description": "Create a User.", "operationId": "BackendService_CreateUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Users", "x-fern-sdk-method-name": "CreateUser", "summary": "Create User" } }, "/v1/users/{id}": { "get": { "tags": [ "BackendService" ], "description": "Get a User.", "operationId": "BackendService_GetUser", "parameters": [ { "name": "id", "in": "path", "description": "The User ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Users", "x-fern-sdk-method-name": "GetUser", "summary": "Get User" }, "delete": { "tags": [ "BackendService" ], "description": "Delete a User.", "operationId": "BackendService_DeleteUser", "parameters": [ { "name": "id", "in": "path", "description": "The User ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteUserResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Users", "x-fern-sdk-method-name": "DeleteUser", "summary": "Delete User" }, "patch": { "tags": [ "BackendService" ], "description": "Update a User.", "operationId": "BackendService_UpdateUser", "parameters": [ { "name": "id", "in": "path", "description": "The User ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-group-name": "Users", "x-fern-sdk-method-name": "UpdateUser", "summary": "Update User" } } }, "components": { "schemas": { "APIKey": { "type": "object", "properties": { "id": { "type": "string", "description": "The API Key ID. Starts with `api_key_...`." }, "organizationId": { "type": "string", "description": "The Organization this API Key belongs to." }, "createTime": { "type": "string", "description": "When the API Key was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the API Key was last updated.", "format": "date-time" }, "expireTime": { "type": "string", "description": "The expire time of the API Key.", "format": "date-time" }, "displayName": { "type": "string", "description": "A human-readable display name for this API Key." }, "secretToken": { "type": "string", "description": "The secret token for this API Key." }, "secretTokenSuffix": { "type": "string", "description": "The secret token suffix for this API Key." }, "revoked": { "type": "boolean", "description": "Whether this API Key is revoked." } } }, "APIKeyRoleAssignment": { "type": "object", "properties": { "id": { "type": "string", "description": "The API Key Role Assignment ID. Starts with `api_key_role_assignment_...`." }, "apiKeyId": { "type": "string", "description": "The API Key ID." }, "roleId": { "type": "string", "description": "The Role ID." } } }, "AuditLogEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "The Audit Log Event ID. Starts with `audit_log_event_...`." }, "organizationId": { "type": "string", "description": "The Organization the event occurred within, if any." }, "actorUserId": { "type": "string", "description": "The User that performed the event, if any." }, "actorSessionId": { "type": "string", "description": "The Session that performed the event, if any." }, "actorApiKeyId": { "type": "string", "description": "The API Key that performed the event, if any." }, "actorBackendApiKeyId": { "type": "string", "description": "The Backend API key that performed the event, if any." }, "actorIntermediateSessionId": { "type": "string", "description": "The Intermediate Session that performed the action, if any." }, "eventTime": { "type": "string", "description": "When the event occurred.", "format": "date-time" }, "eventName": { "type": "string", "description": "The name of the event." }, "eventDetails": { "type": "object", "description": "The event payload JSON." }, "actorCredentials": { "type": "string", "description": "Credentials for the actor performing the action. Input-only.\n\n Can be used as a shorthand for actor information when calling CreateAuditLogEvent." } }, "description": "AuditLogEvent represents a record in the Project's audit log." }, "AuthenticateAPIKeyRequest": { "type": "object", "properties": { "secretToken": { "type": "string" } } }, "AuthenticateAPIKeyResponse": { "type": "object", "properties": { "apiKeyId": { "type": "string" }, "organizationId": { "type": "string" }, "actions": { "type": "array", "items": { "type": "string" } } } }, "CreateAPIKeyRequest": { "type": "object", "properties": { "apiKey": { "$ref": "#/components/schemas/APIKey" } } }, "CreateAPIKeyResponse": { "type": "object", "properties": { "apiKey": { "$ref": "#/components/schemas/APIKey" } } }, "CreateAPIKeyRoleAssignmentRequest": { "type": "object", "properties": { "apiKeyRoleAssignment": { "$ref": "#/components/schemas/APIKeyRoleAssignment" } } }, "CreateAPIKeyRoleAssignmentResponse": { "type": "object", "properties": { "apiKeyRoleAssignment": { "$ref": "#/components/schemas/APIKeyRoleAssignment" } } }, "CreateAuditLogEventResponse": { "type": "object", "properties": { "auditLogEvent": { "$ref": "#/components/schemas/AuditLogEvent" } } }, "CreateOIDCConnectionResponse": { "type": "object", "properties": { "oidcConnection": { "allOf": [ { "$ref": "#/components/schemas/OIDCConnection" } ], "description": "The created OIDC Connection." } } }, "CreateOrganizationResponse": { "type": "object", "properties": { "organization": { "allOf": [ { "$ref": "#/components/schemas/Organization" } ], "description": "The Organization to create." } } }, "CreateRoleResponse": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Role" } } }, "CreateSAMLConnectionResponse": { "type": "object", "properties": { "samlConnection": { "allOf": [ { "$ref": "#/components/schemas/SAMLConnection" } ], "description": "The created SAML Connection." } } }, "CreateSCIMAPIKeyResponse": { "type": "object", "properties": { "scimApiKey": { "allOf": [ { "$ref": "#/components/schemas/SCIMAPIKey" } ], "description": "The created SCIM API Key." } } }, "CreateUserInviteResponse": { "type": "object", "properties": { "userInvite": { "allOf": [ { "$ref": "#/components/schemas/UserInvite" } ], "description": "The created User Invite." } } }, "CreateUserResponse": { "type": "object", "properties": { "user": { "allOf": [ { "$ref": "#/components/schemas/User" } ], "description": "The created User." } } }, "CreateUserRoleAssignmentResponse": { "type": "object", "properties": { "userRoleAssignment": { "$ref": "#/components/schemas/UserRoleAssignment" } } }, "DeleteAPIKeyResponse": { "type": "object", "properties": {} }, "DeleteAPIKeyRoleAssignmentResponse": { "type": "object", "properties": {} }, "DeleteOIDCConnectionResponse": { "type": "object", "properties": {} }, "DeleteOrganizationResponse": { "type": "object", "properties": {} }, "DeletePasskeyResponse": { "type": "object", "properties": {} }, "DeleteRoleResponse": { "type": "object", "properties": {} }, "DeleteSAMLConnectionResponse": { "type": "object", "properties": {} }, "DeleteSCIMAPIKeyResponse": { "type": "object", "properties": {} }, "DeleteUserInviteResponse": { "type": "object", "properties": {} }, "DeleteUserResponse": { "type": "object", "properties": {} }, "DeleteUserRoleAssignmentResponse": { "type": "object", "properties": {} }, "GetAPIKeyResponse": { "type": "object", "properties": { "apiKey": { "$ref": "#/components/schemas/APIKey" } } }, "GetOIDCConnectionResponse": { "type": "object", "properties": { "oidcConnection": { "allOf": [ { "$ref": "#/components/schemas/OIDCConnection" } ], "description": "The requested OIDC Connection." } } }, "GetOrganizationDomainsResponse": { "type": "object", "properties": { "organizationDomains": { "allOf": [ { "$ref": "#/components/schemas/OrganizationDomains" } ], "description": "The requested Organization Domains." } } }, "GetOrganizationGoogleHostedDomainsResponse": { "type": "object", "properties": { "organizationGoogleHostedDomains": { "allOf": [ { "$ref": "#/components/schemas/OrganizationGoogleHostedDomains" } ], "description": "The Organization's Google Hosted Domains." } } }, "GetOrganizationMicrosoftTenantIDsResponse": { "type": "object", "properties": { "organizationMicrosoftTenantIds": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMicrosoftTenantIDs" } ], "description": "The Organization's Microsoft Tenant IDs." } } }, "GetOrganizationResponse": { "type": "object", "properties": { "organization": { "allOf": [ { "$ref": "#/components/schemas/Organization" } ], "description": "The requested Organization." } } }, "GetPasskeyResponse": { "type": "object", "properties": { "passkey": { "allOf": [ { "$ref": "#/components/schemas/Passkey" } ], "description": "The requested Passkey." } } }, "GetProjectResponse": { "type": "object", "properties": { "project": { "allOf": [ { "$ref": "#/components/schemas/Project" } ], "description": "The requested Project." } } }, "GetRoleResponse": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Role" } } }, "GetSAMLConnectionResponse": { "type": "object", "properties": { "samlConnection": { "allOf": [ { "$ref": "#/components/schemas/SAMLConnection" } ], "description": "The requested SAML Connection." } } }, "GetSCIMAPIKeyResponse": { "type": "object", "properties": { "scimApiKey": { "allOf": [ { "$ref": "#/components/schemas/SCIMAPIKey" } ], "description": "The requested SCIM API Key." } } }, "GetSessionResponse": { "type": "object", "properties": { "session": { "allOf": [ { "$ref": "#/components/schemas/Session" } ], "description": "The requested Session." } } }, "GetUserInviteResponse": { "type": "object", "properties": { "userInvite": { "allOf": [ { "$ref": "#/components/schemas/UserInvite" } ], "description": "The requested User Invite." } } }, "GetUserResponse": { "type": "object", "properties": { "user": { "allOf": [ { "$ref": "#/components/schemas/User" } ], "description": "The requested User." } } }, "GetUserRoleAssignmentResponse": { "type": "object", "properties": { "userRoleAssignment": { "$ref": "#/components/schemas/UserRoleAssignment" } } }, "ListAPIKeyRoleAssignmentsResponse": { "type": "object", "properties": { "apiKeyRoleAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/APIKeyRoleAssignment" } }, "nextPageToken": { "type": "string" } } }, "ListAPIKeysResponse": { "type": "object", "properties": { "apiKeys": { "type": "array", "items": { "$ref": "#/components/schemas/APIKey" } }, "nextPageToken": { "type": "string" } } }, "ListOIDCConnectionsResponse": { "type": "object", "properties": { "oidcConnections": { "type": "array", "items": { "$ref": "#/components/schemas/OIDCConnection" }, "description": "A list of OIDC Connections." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results. Empty if there is no\n next page." } } }, "ListOrganizationsResponse": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" }, "description": "A list of Organizations." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results. Empty if there is no\n next page." } } }, "ListPasskeysResponse": { "type": "object", "properties": { "passkeys": { "type": "array", "items": { "$ref": "#/components/schemas/Passkey" }, "description": "A list of Passkeys." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results. Empty if there is no next page." } } }, "ListRolesResponse": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } }, "nextPageToken": { "type": "string" } } }, "ListSAMLConnectionsResponse": { "type": "object", "properties": { "samlConnections": { "type": "array", "items": { "$ref": "#/components/schemas/SAMLConnection" }, "description": "A list of SAML Connections." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results. Empty if there is no\n next page." } } }, "ListSCIMAPIKeysResponse": { "type": "object", "properties": { "scimApiKeys": { "type": "array", "items": { "$ref": "#/components/schemas/SCIMAPIKey" }, "description": "A list of SCIM API Keys." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results. Empty if there is no\n next page." } } }, "ListSessionsResponse": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/Session" }, "description": "A list of Sessions." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results. Empty if there is no next page." } } }, "ListUserInvitesResponse": { "type": "object", "properties": { "userInvites": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvite" }, "description": "A list of User Invites." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results. Empty if there is no next page." } } }, "ListUserRoleAssignmentsResponse": { "type": "object", "properties": { "userRoleAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignment" } }, "nextPageToken": { "type": "string" } } }, "ListUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "description": "A list of Users." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results. Empty if there is no next page." } } }, "OIDCConnection": { "type": "object", "properties": { "id": { "type": "string", "description": "The OIDC Connection ID. Starts with `oidc_connection_...`." }, "organizationId": { "type": "string", "description": "The Organization this OIDC Connection belongs to." }, "createTime": { "type": "string", "description": "When the OIDC Connection was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the OIDC Connection was last updated.", "format": "date-time" }, "primary": { "type": "boolean", "description": "Whether this is the primary OIDC Connection for the Organization." }, "configurationUrl": { "type": "string", "description": "The OIDC Provider's configuration URL." }, "clientId": { "type": "string", "description": "The OIDC Provider's Client ID." }, "clientSecret": { "type": "string", "description": "The OIDC Provider's Client Secret.\n This field is write-only." }, "redirectUri": { "type": "string", "description": "The OIDC Provider's redirect URI." } }, "description": "OIDCConnection represents an OpenID Connect configuration for an Organization." }, "Organization": { "type": "object", "properties": { "id": { "type": "string", "description": "The Organization ID. Starts with `org_...`." }, "displayName": { "type": "string", "description": "A human-friendly name for the Organization." }, "createTime": { "type": "string", "description": "When the Organization was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the Organization was last updated.", "format": "date-time" }, "logInWithGoogle": { "type": "boolean", "description": "Whether the Organization supports \"Log in with Google\"." }, "logInWithMicrosoft": { "type": "boolean", "description": "Whether the Organization supports \"Log in with Microsoft\"." }, "logInWithGithub": { "type": "boolean", "description": "Whether the Organization supports Log in with GitHub." }, "logInWithEmail": { "type": "boolean", "description": "Whether the Organization supports \"Log in with email\"." }, "logInWithPassword": { "type": "boolean", "description": "Whether the Organization supports \"Log in with password\"." }, "logInWithSaml": { "type": "boolean", "description": "Whether the Organization supports \"Log in with SAML\"." }, "logInWithOidc": { "type": "boolean", "description": "Whether the Organization supports \"Log in with OIDC\"." }, "logInWithAuthenticatorApp": { "type": "boolean", "description": "Whether the Organization supports authenticator apps as a secondary auth factor." }, "logInWithPasskey": { "type": "boolean", "description": "Whether the Organization supports passkeys as a secondary auth factor." }, "requireMfa": { "type": "boolean", "description": "Whether the Organization requires a secondary auth factor." }, "scimEnabled": { "type": "boolean", "description": "Whether the Organization has SCIM enabled." }, "customRolesEnabled": { "type": "boolean", "description": "Whether the Organization's Users can create Organization-specific Roles." }, "apiKeysEnabled": { "type": "boolean", "description": "Whether API Keys are enabled for the Organization." } }, "description": "An Organization represents one of your corporate customers." }, "OrganizationDomains": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The ID of the Organization." }, "domains": { "type": "array", "items": { "type": "string" }, "description": "A list of domains associated with the organization.\n\n When an Organization uses SAML or SCIM, only emails from this list are\n permitted." } }, "description": "OrganizationDomains defines the domains associated with an Organization." }, "OrganizationGoogleHostedDomains": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The ID of the Organization." }, "googleHostedDomains": { "type": "array", "items": { "type": "string" }, "description": "A list of Google-hosted domains associated with the organization.\n\n These values correspond to Google OAuth `hd` claims:\n\n https://developers.google.com/identity/openid-connect/openid-connect#obtainuserinfo" } }, "description": "OrganizationGoogleHostedDomains represents the Google Hosted Domains (\"HDs\")\n associated with an Organization." }, "OrganizationMicrosoftTenantIDs": { "type": "object", "properties": { "organizationId": { "type": "string", "description": "The ID of the Organization." }, "microsoftTenantIds": { "type": "array", "items": { "type": "string" }, "description": "A list of Microsoft Tenant IDs associated with the organization.\n\n These values correspond to Microsoft OAuth `tid` claims:\n\n https://learn.microsoft.com/en-us/entra/identity-platform/id-token-claims-reference" } }, "description": "OrganizationMicrosoftTenantIDs represents the Microsoft Tenant IDs (\"TIDs\")\n associated with an Organization." }, "Passkey": { "type": "object", "properties": { "id": { "type": "string", "description": "The Passkey ID. Starts with `passkey_...`." }, "userId": { "type": "string", "description": "The User this Passkey belongs to." }, "createTime": { "type": "string", "description": "The timestamp of when the Passkey was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "The timestamp of when the Passkey was last updated.", "format": "date-time" }, "disabled": { "type": "boolean", "description": "Indicates whether the Passkey is disabled." }, "credentialId": { "type": "string", "description": "The unique credential ID for the Passkey, as a binary value.", "format": "bytes" }, "publicKeyPkix": { "type": "string", "description": "The public key associated with the Passkey, in PEM-encoded PKIX format.\n\n Starts with `-----BEGIN PUBLIC KEY-----`." }, "aaguid": { "type": "string", "description": "The Authenticator Attestation GUID (AAGUID) for the Passkey." }, "rpId": { "type": "string", "description": "The relying party ID associated with the Passkey." } }, "description": "Passkey represents a WebAuthn public key credential registered by a User." }, "Project": { "type": "object", "properties": { "id": { "type": "string", "description": "The Project ID. Starts with `project_...`." }, "displayName": { "type": "string", "description": "A human-friendly name for the Project." }, "createTime": { "type": "string", "description": "When the Project was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the Project was last modified.", "format": "date-time" }, "logInWithGoogle": { "type": "boolean", "description": "Whether the Project supports \"Log in with Google\"." }, "logInWithMicrosoft": { "type": "boolean", "description": "Whether the Project supports \"Log in with Microsoft\"." }, "logInWithGithub": { "type": "boolean", "description": "Whether the Project supports \"Log in with GitHub\"." }, "logInWithEmail": { "type": "boolean", "description": "Whether the Project supports \"Log in with email\"." }, "logInWithPassword": { "type": "boolean", "description": "Whether the Project supports \"Log in with password\"." }, "logInWithSaml": { "type": "boolean", "description": "Whether the Project supports \"Log in with SAML\"." }, "logInWithOidc": { "type": "boolean", "description": "Whether the Project supports \"Log in with OIDC\"." }, "logInWithAuthenticatorApp": { "type": "boolean", "description": "Whether the Project supports authenticator apps as a secondary auth factor." }, "logInWithPasskey": { "type": "boolean", "description": "Whether the Project supports passkeys as a secondary auth factor." }, "googleOauthClientId": { "type": "string", "description": "The OAuth Client ID to use for \"Log in with Google\"." }, "googleOauthClientSecret": { "type": "string", "description": "The OAuth Client Secret to use for \"Log in with Google\".\n\n This field is write-only." }, "microsoftOauthClientId": { "type": "string", "description": "The OAuth Client ID to use for \"Log in with Microsoft\"." }, "microsoftOauthClientSecret": { "type": "string", "description": "The OAuth Client Secret to use for \"Log in with Microsoft\".\n\n This field is write-only." }, "githubOauthClientId": { "type": "string", "description": "The OAuth Client ID to use for \"Log in with GitHub\"." }, "githubOauthClientSecret": { "type": "string", "description": "The OAuth Client ID to use for \"Log in with GitHub\"\n\n This field is write only." }, "vaultDomain": { "type": "string", "description": "The domain where the Project's Vault lives." }, "vaultDomainCustom": { "type": "boolean", "description": "Whether vault_domain is different from the automatically-assigned one." }, "trustedDomains": { "type": "array", "items": { "type": "string" }, "description": "The set of domains the Project trusts.\n\n Client-side JavaScript on these domains can take actions on behalf of\n logged-in Users." }, "cookieDomain": { "type": "string", "description": "The domain that authentication cookies are stored on." }, "redirectUri": { "type": "string", "description": "Where Users are redirected after returning from the Vault." }, "afterLoginRedirectUri": { "type": "string", "description": "Where Users are redirected after logging in." }, "afterSignupRedirectUri": { "type": "string", "description": "Where Users are redirected after signing up." }, "emailSendFromDomain": { "type": "string", "description": "Emails sent to Users come from this domain." }, "apiKeysEnabled": { "type": "boolean", "description": "Whether the Project supports API Keys." }, "apiKeySecretTokenPrefix": { "type": "string", "description": "The prefix used for API Key secret tokens." }, "auditLogsEnabled": { "type": "boolean", "description": "Whether the Project has audit logging enabled." } }, "description": "Projects are the top-level object in Tesseral.\n\n Everything in Tesseral happens within the context of a Project." }, "RevokeAPIKeyResponse": { "type": "object", "properties": {} }, "RevokeSCIMAPIKeyResponse": { "type": "object", "properties": { "scimApiKey": { "allOf": [ { "$ref": "#/components/schemas/SCIMAPIKey" } ], "description": "The revoked SCIM API Key." } } }, "Role": { "type": "object", "properties": { "id": { "type": "string", "description": "The Role ID. Starts with `role_...`." }, "organizationId": { "type": "string", "description": "The Organization this Role belongs to, if any." }, "createTime": { "type": "string", "description": "When the Role was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the Role was last updated.", "format": "date-time" }, "displayName": { "type": "string", "description": "A human-readable display name for this Role." }, "description": { "type": "string", "description": "A human-readable description of the Role." }, "actions": { "type": "array", "items": { "type": "string" }, "description": "The names of the Actions associated with this Role." } }, "description": "Role represents a logical grouping of permissions that Users may have." }, "SAMLConnection": { "type": "object", "properties": { "id": { "type": "string", "description": "The SAML Connection ID. Starts with `saml_connection_...`." }, "organizationId": { "type": "string", "description": "The Organization this SAML Connection belongs to." }, "createTime": { "type": "string", "description": "When the SAML Connection was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the SAML Connection was last updated.", "format": "date-time" }, "primary": { "type": "boolean", "description": "Whether this is the primary SAML Connection for the Organization." }, "spAcsUrl": { "type": "string", "description": "The Service Provider Assertion Consumer Service (ACS) URL." }, "spEntityId": { "type": "string", "description": "The Service Provider Entity ID." }, "idpRedirectUrl": { "type": "string", "description": "The Identity Provider Redirect URL." }, "idpX509Certificate": { "type": "string", "description": "The Identity Provider certificate, in PEM-encoded X.509 format.\n\n Starts with `----BEGIN CERTIFICATE----`." }, "idpEntityId": { "type": "string", "description": "The Identity Provider Entity ID." } }, "description": "SAMLConnection represents a SAML configuration for an Organization." }, "SCIMAPIKey": { "type": "object", "properties": { "id": { "type": "string", "description": "The SCIM API Key ID. Starts with `scim_api_key_...`." }, "organizationId": { "type": "string", "description": "The Organization this SCIM API Key belongs to." }, "createTime": { "type": "string", "description": "When the SCIM API Key was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the SCIM API Key was last updated.", "format": "date-time" }, "displayName": { "type": "string", "description": "A human-readable display name for this SCIM API Key." }, "secretToken": { "type": "string", "description": "The secret token for this SCIM API Key." }, "revoked": { "type": "boolean", "description": "Whether this SCIM API Key is revoked." } }, "description": "SCIMAPIKey represents an API key for SCIM operations." }, "Session": { "type": "object", "properties": { "id": { "type": "string", "description": "The Session ID. Starts with `session_...`." }, "userId": { "type": "string", "description": "The User this Session belongs to." }, "revoked": { "type": "boolean", "description": "Whether the Session is revoked." }, "createTime": { "type": "string", "description": "When the Session was created.", "format": "date-time" }, "lastActiveTime": { "type": "string", "description": "When the Session was last active.", "format": "date-time" }, "expireTime": { "type": "string", "description": "When the Session expires.", "format": "date-time" }, "primaryAuthFactor": { "type": "integer", "description": "The primary authentication factor the end user used to log in.", "format": "enum" } }, "description": "Represents a Session for a logged-in User." }, "UpdateAPIKeyRequest": { "type": "object", "properties": { "id": { "type": "string" }, "apiKey": { "$ref": "#/components/schemas/APIKey" } } }, "UpdateAPIKeyResponse": { "type": "object", "properties": { "apiKey": { "$ref": "#/components/schemas/APIKey" } } }, "UpdateOIDCConnectionResponse": { "type": "object", "properties": { "oidcConnection": { "allOf": [ { "$ref": "#/components/schemas/OIDCConnection" } ], "description": "The updated OIDC Connection." } } }, "UpdateOrganizationDomainsResponse": { "type": "object", "properties": { "organizationDomains": { "allOf": [ { "$ref": "#/components/schemas/OrganizationDomains" } ], "description": "The updated Organization Domains." } } }, "UpdateOrganizationGoogleHostedDomainsResponse": { "type": "object", "properties": { "organizationGoogleHostedDomains": { "allOf": [ { "$ref": "#/components/schemas/OrganizationGoogleHostedDomains" } ], "description": "The updated Google Hosted Domains for the Organization." } } }, "UpdateOrganizationMicrosoftTenantIDsResponse": { "type": "object", "properties": { "organizationMicrosoftTenantIds": { "allOf": [ { "$ref": "#/components/schemas/OrganizationMicrosoftTenantIDs" } ], "description": "The updated Microsoft Tenant IDs for the Organization." } } }, "UpdateOrganizationResponse": { "type": "object", "properties": { "organization": { "allOf": [ { "$ref": "#/components/schemas/Organization" } ], "description": "The updated Organization." } } }, "UpdatePasskeyResponse": { "type": "object", "properties": { "passkey": { "allOf": [ { "$ref": "#/components/schemas/Passkey" } ], "description": "The updated Passkey." } } }, "UpdateRoleResponse": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Role" } } }, "UpdateSAMLConnectionResponse": { "type": "object", "properties": { "samlConnection": { "allOf": [ { "$ref": "#/components/schemas/SAMLConnection" } ], "description": "The updated SAML Connection." } } }, "UpdateSCIMAPIKeyResponse": { "type": "object", "properties": { "scimApiKey": { "allOf": [ { "$ref": "#/components/schemas/SCIMAPIKey" } ], "description": "The updated SCIM API Key." } } }, "UpdateUserResponse": { "type": "object", "properties": { "user": { "allOf": [ { "$ref": "#/components/schemas/User" } ], "description": "The updated User." } } }, "User": { "type": "object", "properties": { "id": { "type": "string", "description": "The User ID. Starts with `user_...`." }, "organizationId": { "type": "string", "description": "The Organization this User belongs to." }, "email": { "type": "string", "description": "The User's email address.\n\n This email is verified and unique within the Organization. Two Users in\n different Organizations may have the same email." }, "createTime": { "type": "string", "description": "When the User was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the User was last updated.", "format": "date-time" }, "owner": { "type": "boolean", "description": "Whether the User is an owner of their Organization." }, "googleUserId": { "type": "string", "description": "The Google User ID, if the User has ever logged in with Google." }, "microsoftUserId": { "type": "string", "description": "The Microsoft User ID, if the User has ever logged in with Microsoft." }, "githubUserId": { "type": "string", "description": "The Github User ID, if the User has ever logged in with GitHub." }, "hasAuthenticatorApp": { "type": "boolean", "description": "Whether the User has an authenticator app set up." }, "displayName": { "type": "string", "description": "The User's human-friendly name." }, "profilePictureUrl": { "type": "string", "description": "The URL of the User's profile picture." } }, "description": "A User represents an individual working for one of your corporate customers." }, "UserInvite": { "type": "object", "properties": { "id": { "type": "string", "description": "The User Invite ID. Starts with `user_invite_...`." }, "organizationId": { "type": "string", "description": "The Organization this User Invite belongs to." }, "createTime": { "type": "string", "description": "When the User Invite was created.", "format": "date-time" }, "updateTime": { "type": "string", "description": "When the User Invite was last updated.", "format": "date-time" }, "email": { "type": "string", "description": "The invitee's email address." }, "owner": { "type": "boolean", "description": "Indicates whether the invited User will have owner privileges in the\n Organization." } }, "description": "UserInvite represents an invitation for a User to join an Organization." }, "UserRoleAssignment": { "type": "object", "properties": { "id": { "type": "string", "description": "The User Role Assignment ID. Starts with `user_role_assignment_...`." }, "userId": { "type": "string", "description": "The User ID." }, "roleId": { "type": "string", "description": "The Role ID." } }, "description": "UserRoleAssignment represents a User being assigned to a Role." }, "APIError": { "type": "object", "description": "An error returned from Tesseral.", "properties": { "message": { "type": "string", "description": "A developer-facing error message, such as \"not_found\". These are stable, and you can develop code that matches against them." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/APIErrorDetail" }, "description": "Additional details about this error." } } }, "ErrorDetail": { "type": "object", "properties": { "description": { "type": "string", "description": "A human-friendly description for the error. May change at any time." }, "docsLink": { "type": "string", "description": "A link to the documentation about the error. May change at any time." } }, "description": "An error returned from a Tesseral API." }, "AccessTokenClaims": { "type": "object", "properties": { "iss": { "type": "string", "description": "Will always be of the form \"https://project-xxx.tesseral.app\", where\n \"project-xxx\" is your Project ID." }, "sub": { "type": "string", "description": "Will always be equal to the `user.id` claim." }, "aud": { "type": "string", "description": "Will always be equal to the `iss` claim." }, "exp": { "type": "number", "description": "When this Access Token expires, in seconds since the unix epoch.", "format": "double" }, "nbf": { "type": "number", "description": "When this Access Token was issued, in seconds since the unix epoch.", "format": "double" }, "iat": { "type": "number", "description": "Will always be equal to the `nbf` claim.", "format": "double" }, "actions": { "type": "array", "description": "The set of actions the User has permission to carry out.", "items": { "type": "string" } }, "organization": { "allOf": [ { "$ref": "#/components/schemas/AccessTokenOrganization" } ], "description": "The Organization the User is logged into." }, "user": { "allOf": [ { "$ref": "#/components/schemas/AccessTokenUser" } ], "description": "The User that's logged in." }, "session": { "allOf": [ { "$ref": "#/components/schemas/AccessTokenSession" } ], "description": "The user's current Session." }, "impersonator": { "allOf": [ { "$ref": "#/components/schemas/AccessTokenImpersonator" } ], "description": "If this is an impersonated Session, this contains information about who on\n your staff is impersonating the user." } }, "required": [ "iss", "sub", "aud", "exp", "nbf", "iat", "organization", "user", "session" ], "description": "The claims encoded in an Access Token." }, "AccessTokenImpersonator": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the individual on your staff impersonating the User." } }, "required": [ "email" ], "description": "Information in an Access Token about who is impersonating the User." }, "AccessTokenOrganization": { "type": "object", "properties": { "id": { "type": "string", "description": "The Organization's ID." }, "displayName": { "type": "string", "description": "The Organization's display name." } }, "required": [ "id", "displayName" ], "description": "Information in an Access Token about the Organization the User is logged\n into." }, "AccessTokenSession": { "type": "object", "properties": { "id": { "type": "string", "description": "The Session ID." } }, "required": [ "id" ], "description": "Information in an Access Token about the current Session." }, "AccessTokenUser": { "type": "object", "properties": { "id": { "type": "string", "description": "The User's ID." }, "email": { "type": "string", "description": "The User's email." }, "displayName": { "type": "string", "description": "The User's full name." }, "profilePictureUrl": { "type": "string", "description": "A URL of the User's profile picture." } }, "required": [ "id", "email" ], "description": "Information in an Access Token about the logged-in User." } }, "responses": { "APIError": { "description": "API Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIError" } } } } } }, "tags": [ { "name": "BackendService" } ] }