{ "openapi": "3.0.3", "info": { "title": "FrontendService API", "version": "0.0.1" }, "paths": { "/frontend/v1/api-key-role-assignments": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_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": [ "FrontendService" ], "operationId": "FrontendService_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" } }, "/frontend/v1/api-key-role-assignments/{id}": { "delete": { "tags": [ "FrontendService" ], "operationId": "FrontendService_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" } }, "/frontend/v1/api-keys": { "get": { "tags": [ "FrontendService" ], "description": "List API Keys.", "operationId": "FrontendService_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": [ "FrontendService" ], "description": "Create an API Key for an Organization.", "operationId": "FrontendService_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" } }, "/frontend/v1/api-keys/{id}": { "get": { "tags": [ "FrontendService" ], "description": "Get an API Key.", "operationId": "FrontendService_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": [ "FrontendService" ], "description": "Delete an API Key.", "operationId": "FrontendService_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": [ "FrontendService" ], "description": "Update an API Key.", "operationId": "FrontendService_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" } }, "/frontend/v1/api-keys/{id}/revoke": { "post": { "tags": [ "FrontendService" ], "description": "Revoke an API Key.", "operationId": "FrontendService_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" } }, "/frontend/v1/audit-log-events": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_ListAuditLogEvents", "parameters": [ { "name": "pageToken", "in": "query", "schema": { "type": "string" } }, { "name": "filterStartTime", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "filterEndTime", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "filterEventName", "in": "query", "schema": { "type": "string" } }, { "name": "filterUserId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAuditLogEventsResponse" } } } }, "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": "ListAuditLogEvents", "summary": "List Audit Log Events" } }, "/frontend/v1/google-hosted-domains": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetOrganizationGoogleHostedDomains", "parameters": [ { "name": "organizationId", "in": "query", "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": [ "FrontendService" ], "operationId": "FrontendService_UpdateOrganizationGoogleHostedDomains", "parameters": [ { "name": "organizationId", "in": "query", "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" } }, "/frontend/v1/logout": { "post": { "tags": [ "FrontendService" ], "operationId": "FrontendService_Logout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-method-name": "Logout", "summary": "Logout" } }, "/frontend/v1/me": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_Whoami", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhoamiResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "Whoami", "summary": "Whoami" }, "patch": { "tags": [ "FrontendService" ], "operationId": "FrontendService_UpdateMe", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMeResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "UpdateMe", "summary": "Update Me" } }, "/frontend/v1/me/authenticator-app/options": { "post": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetAuthenticatorAppOptions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAuthenticatorAppOptionsResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "GetAuthenticatorAppOptions", "summary": "Get Authenticator App Options" } }, "/frontend/v1/me/authenticator-app/register": { "post": { "tags": [ "FrontendService" ], "operationId": "FrontendService_RegisterAuthenticatorApp", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterAuthenticatorAppRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterAuthenticatorAppResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "RegisterAuthenticatorApp", "summary": "Register Authenticator App" } }, "/frontend/v1/me/passkeys": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_ListMyPasskeys", "parameters": [ { "name": "pageToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMyPasskeysResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "ListMyPasskeys", "summary": "List My Passkeys" } }, "/frontend/v1/me/passkeys/options": { "post": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetPasskeyOptions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPasskeyOptionsResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "GetPasskeyOptions", "summary": "Get Passkey Options" } }, "/frontend/v1/me/passkeys/register": { "post": { "tags": [ "FrontendService" ], "operationId": "FrontendService_RegisterPasskey", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterPasskeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterPasskeyResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "RegisterPasskey", "summary": "Register Passkey" } }, "/frontend/v1/me/passkeys/{id}": { "delete": { "tags": [ "FrontendService" ], "operationId": "FrontendService_DeleteMyPasskey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMyPasskeyResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "DeleteMyPasskey", "summary": "Delete My Passkey" } }, "/frontend/v1/microsoft-tenant-ids": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetOrganizationMicrosoftTenantIDs", "parameters": [ { "name": "organizationId", "in": "query", "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": [ "FrontendService" ], "operationId": "FrontendService_UpdateOrganizationMicrosoftTenantIDs", "parameters": [ { "name": "organizationId", "in": "query", "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" } }, "/frontend/v1/oidc-connections": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_ListOIDCConnections", "parameters": [ { "name": "pageToken", "in": "query", "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": [ "FrontendService" ], "operationId": "FrontendService_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" } }, "/frontend/v1/oidc-connections/{id}": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetOIDCConnection", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_DeleteOIDCConnection", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_UpdateOIDCConnection", "parameters": [ { "name": "id", "in": "path", "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" } }, "/frontend/v1/organization": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetOrganization", "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" }, "patch": { "tags": [ "FrontendService" ], "operationId": "FrontendService_UpdateOrganization", "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" } }, "/frontend/v1/project": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_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" } }, "/frontend/v1/refresh": { "post": { "tags": [ "FrontendService" ], "operationId": "FrontendService_Refresh", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshResponse" } } } }, "400": { "$ref": "#/components/responses/APIError" }, "401": { "$ref": "#/components/responses/APIError" }, "403": { "$ref": "#/components/responses/APIError" }, "404": { "$ref": "#/components/responses/APIError" } }, "x-fern-sdk-method-name": "Refresh", "summary": "Refresh" } }, "/frontend/v1/roles": { "get": { "tags": [ "FrontendService" ], "description": "List Roles.", "operationId": "FrontendService_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": [ "FrontendService" ], "description": "Create a Role.", "operationId": "FrontendService_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" } }, "/frontend/v1/roles/{id}": { "get": { "tags": [ "FrontendService" ], "description": "Get a Role.", "operationId": "FrontendService_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": [ "FrontendService" ], "description": "Delete a Role.", "operationId": "FrontendService_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": [ "FrontendService" ], "description": "Update a Role.", "operationId": "FrontendService_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" } }, "/frontend/v1/saml-connections": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_ListSAMLConnections", "parameters": [ { "name": "pageToken", "in": "query", "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": [ "FrontendService" ], "operationId": "FrontendService_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" } }, "/frontend/v1/saml-connections/{id}": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetSAMLConnection", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_DeleteSAMLConnection", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_UpdateSAMLConnection", "parameters": [ { "name": "id", "in": "path", "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" } }, "/frontend/v1/scim-api-keys": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_ListSCIMAPIKeys", "parameters": [ { "name": "pageToken", "in": "query", "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": [ "FrontendService" ], "operationId": "FrontendService_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" } }, "/frontend/v1/scim-api-keys/{id}": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetSCIMAPIKey", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_DeleteSCIMAPIKey", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_UpdateSCIMAPIKey", "parameters": [ { "name": "id", "in": "path", "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" } }, "/frontend/v1/scim-api-keys/{id}/revoke": { "post": { "tags": [ "FrontendService" ], "operationId": "FrontendService_RevokeSCIMAPIKey", "parameters": [ { "name": "id", "in": "path", "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" } }, "/frontend/v1/set-user-password": { "post": { "tags": [ "FrontendService" ], "description": "Sets a user's password.", "operationId": "FrontendService_SetPassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPasswordResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "SetPassword", "summary": "Set Password" } }, "/frontend/v1/switch-organizations/organizations": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_ListSwitchableOrganizations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSwitchableOrganizationsResponse" } } } }, "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": "Me", "x-fern-sdk-method-name": "ListSwitchableOrganizations", "summary": "List Switchable Organizations" } }, "/frontend/v1/user-invites": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_ListUserInvites", "parameters": [ { "name": "pageToken", "in": "query", "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": [ "FrontendService" ], "operationId": "FrontendService_CreateUserInvite", "parameters": [ { "name": "sendEmail", "in": "query", "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" } }, "/frontend/v1/user-invites/{id}": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetUserInvite", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_DeleteUserInvite", "parameters": [ { "name": "id", "in": "path", "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" } }, "/frontend/v1/user-role-assignments": { "get": { "tags": [ "FrontendService" ], "description": "List User Role Assignments.", "operationId": "FrontendService_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": [ "FrontendService" ], "description": "Create a User Role Assignment.", "operationId": "FrontendService_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" } }, "/frontend/v1/user-role-assignments/{id}": { "get": { "tags": [ "FrontendService" ], "description": "Get a User Role Assignment.", "operationId": "FrontendService_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": [ "FrontendService" ], "description": "Delete a User Role Assignment.", "operationId": "FrontendService_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" } }, "/frontend/v1/users": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_ListUsers", "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/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" } }, "/frontend/v1/users/{id}": { "get": { "tags": [ "FrontendService" ], "operationId": "FrontendService_GetUser", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_DeleteUser", "parameters": [ { "name": "id", "in": "path", "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": [ "FrontendService" ], "operationId": "FrontendService_UpdateUser", "parameters": [ { "name": "id", "in": "path", "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" } } }, "AuditLogEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "The Audit Log Event ID. Starts with `audit_log_event_...`." }, "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." }, "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." } } }, "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" } } }, "CreateOIDCConnectionResponse": { "type": "object", "properties": { "oidcConnection": { "$ref": "#/components/schemas/OIDCConnection" } } }, "CreateRoleResponse": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Role" } } }, "CreateSAMLConnectionResponse": { "type": "object", "properties": { "samlConnection": { "$ref": "#/components/schemas/SAMLConnection" } } }, "CreateSCIMAPIKeyResponse": { "type": "object", "properties": { "scimApiKey": { "$ref": "#/components/schemas/SCIMAPIKey" } } }, "CreateUserInviteResponse": { "type": "object", "properties": { "userInvite": { "$ref": "#/components/schemas/UserInvite" } } }, "CreateUserRoleAssignmentResponse": { "type": "object", "properties": { "userRoleAssignment": { "$ref": "#/components/schemas/UserRoleAssignment" } } }, "DeleteAPIKeyResponse": { "type": "object", "properties": {} }, "DeleteAPIKeyRoleAssignmentResponse": { "type": "object", "properties": {} }, "DeleteMyPasskeyResponse": { "type": "object", "properties": {} }, "DeleteOIDCConnectionResponse": { "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" } } }, "GetAuthenticatorAppOptionsResponse": { "type": "object", "properties": { "otpauthUri": { "type": "string" } } }, "GetOIDCConnectionResponse": { "type": "object", "properties": { "oidcConnection": { "$ref": "#/components/schemas/OIDCConnection" } } }, "GetOrganizationGoogleHostedDomainsResponse": { "type": "object", "properties": { "organizationGoogleHostedDomains": { "$ref": "#/components/schemas/OrganizationGoogleHostedDomains" } } }, "GetOrganizationMicrosoftTenantIDsResponse": { "type": "object", "properties": { "organizationMicrosoftTenantIds": { "$ref": "#/components/schemas/OrganizationMicrosoftTenantIDs" } } }, "GetOrganizationResponse": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/Organization" } } }, "GetPasskeyOptionsResponse": { "type": "object", "properties": { "rpId": { "type": "string" }, "rpName": { "type": "string" }, "userId": { "type": "string" }, "userDisplayName": { "type": "string" } } }, "GetProjectResponse": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/Project" } } }, "GetRoleResponse": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Role" } } }, "GetSAMLConnectionResponse": { "type": "object", "properties": { "samlConnection": { "$ref": "#/components/schemas/SAMLConnection" } } }, "GetSCIMAPIKeyResponse": { "type": "object", "properties": { "scimApiKey": { "$ref": "#/components/schemas/SCIMAPIKey" } } }, "GetUserInviteResponse": { "type": "object", "properties": { "userInvite": { "$ref": "#/components/schemas/UserInvite" } } }, "GetUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/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" } } }, "ListAuditLogEventsResponse": { "type": "object", "properties": { "auditLogEvents": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogEvent" } }, "nextPageToken": { "type": "string" } } }, "ListMyPasskeysResponse": { "type": "object", "properties": { "passkeys": { "type": "array", "items": { "$ref": "#/components/schemas/Passkey" } }, "nextPageToken": { "type": "string" } } }, "ListOIDCConnectionsResponse": { "type": "object", "properties": { "oidcConnections": { "type": "array", "items": { "$ref": "#/components/schemas/OIDCConnection" } }, "nextPageToken": { "type": "string" } } }, "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" } }, "nextPageToken": { "type": "string" } } }, "ListSCIMAPIKeysResponse": { "type": "object", "properties": { "scimApiKeys": { "type": "array", "items": { "$ref": "#/components/schemas/SCIMAPIKey" } }, "nextPageToken": { "type": "string" } } }, "ListSwitchableOrganizationsResponse": { "type": "object", "properties": { "switchableOrganizations": { "type": "array", "items": { "$ref": "#/components/schemas/SwitchableOrganization" } } } }, "ListUserInvitesResponse": { "type": "object", "properties": { "userInvites": { "type": "array", "items": { "$ref": "#/components/schemas/UserInvite" } }, "nextPageToken": { "type": "string" } } }, "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" } }, "nextPageToken": { "type": "string" } } }, "LogoutRequest": { "type": "object", "properties": {} }, "LogoutResponse": { "type": "object", "properties": {} }, "OIDCConnection": { "type": "object", "properties": { "id": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "primary": { "type": "boolean" }, "configurationUrl": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "redirectUri": { "type": "string" } } }, "Organization": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "logInWithGoogle": { "type": "boolean" }, "logInWithMicrosoft": { "type": "boolean" }, "logInWithGithub": { "type": "boolean" }, "logInWithEmail": { "type": "boolean" }, "logInWithPassword": { "type": "boolean" }, "logInWithSaml": { "type": "boolean" }, "logInWithOidc": { "type": "boolean" }, "logInWithAuthenticatorApp": { "type": "boolean" }, "logInWithPasskey": { "type": "boolean" }, "requireMfa": { "type": "boolean" }, "googleHostedDomains": { "type": "array", "items": { "type": "string" } }, "microsoftTenantIds": { "type": "array", "items": { "type": "string" } }, "samlEnabled": { "type": "boolean" }, "scimEnabled": { "type": "boolean" }, "customRolesEnabled": { "type": "boolean" }, "apiKeysEnabled": { "type": "boolean" } } }, "OrganizationGoogleHostedDomains": { "type": "object", "properties": { "googleHostedDomains": { "type": "array", "items": { "type": "string" } } } }, "OrganizationMicrosoftTenantIDs": { "type": "object", "properties": { "microsoftTenantIds": { "type": "array", "items": { "type": "string" } } } }, "Passkey": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "disabled": { "type": "boolean" }, "credentialId": { "type": "string", "format": "bytes" }, "publicKeyPkix": { "type": "string" }, "aaguid": { "type": "string" }, "rpId": { "type": "string" } } }, "Project": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "logInWithGoogle": { "type": "boolean" }, "logInWithMicrosoft": { "type": "boolean" }, "logInWithGithub": { "type": "boolean" }, "logInWithEmail": { "type": "boolean" }, "logInWithPassword": { "type": "boolean" }, "logInWithSaml": { "type": "boolean" }, "logInWithOidc": { "type": "boolean" }, "logInWithAuthenticatorApp": { "type": "boolean" }, "logInWithPasskey": { "type": "boolean" }, "vaultDomain": { "type": "string" }, "apiKeysEnabled": { "type": "boolean" }, "apiKeySecretTokenPrefix": { "type": "string" }, "auditLogsEnabled": { "type": "boolean" } } }, "RefreshRequest": { "type": "object", "properties": { "refreshToken": { "type": "string" } } }, "RefreshResponse": { "type": "object", "properties": { "accessToken": { "type": "string" } } }, "RegisterAuthenticatorAppRequest": { "type": "object", "properties": { "totpCode": { "type": "string" } } }, "RegisterAuthenticatorAppResponse": { "type": "object", "properties": { "recoveryCodes": { "type": "array", "items": { "type": "string" } } } }, "RegisterPasskeyRequest": { "type": "object", "properties": { "attestationObject": { "type": "string" }, "rpId": { "type": "string" } } }, "RegisterPasskeyResponse": { "type": "object", "properties": { "passkey": { "$ref": "#/components/schemas/Passkey" } } }, "RevokeAPIKeyResponse": { "type": "object", "properties": {} }, "RevokeSCIMAPIKeyResponse": { "type": "object", "properties": { "scimApiKey": { "$ref": "#/components/schemas/SCIMAPIKey" } } }, "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" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "primary": { "type": "boolean" }, "spAcsUrl": { "type": "string" }, "spEntityId": { "type": "string" }, "idpRedirectUrl": { "type": "string" }, "idpX509Certificate": { "type": "string" }, "idpEntityId": { "type": "string" } } }, "SCIMAPIKey": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "secretToken": { "type": "string" }, "revoked": { "type": "boolean" } } }, "SetPasswordRequest": { "type": "object", "properties": { "password": { "type": "string", "description": "The the user's new password." } } }, "SetPasswordResponse": { "type": "object", "properties": {} }, "SwitchableOrganization": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" } } }, "UpdateAPIKeyRequest": { "type": "object", "properties": { "id": { "type": "string" }, "apiKey": { "$ref": "#/components/schemas/APIKey" } } }, "UpdateAPIKeyResponse": { "type": "object", "properties": { "id": { "type": "string" }, "apiKey": { "$ref": "#/components/schemas/APIKey" } } }, "UpdateMeResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" } } }, "UpdateOIDCConnectionResponse": { "type": "object", "properties": { "oidcConnection": { "$ref": "#/components/schemas/OIDCConnection" } } }, "UpdateOrganizationGoogleHostedDomainsResponse": { "type": "object", "properties": { "organizationGoogleHostedDomains": { "$ref": "#/components/schemas/OrganizationGoogleHostedDomains" } } }, "UpdateOrganizationMicrosoftTenantIDsResponse": { "type": "object", "properties": { "organizationMicrosoftTenantIds": { "$ref": "#/components/schemas/OrganizationMicrosoftTenantIDs" } } }, "UpdateOrganizationResponse": { "type": "object", "properties": { "organization": { "$ref": "#/components/schemas/Organization" } } }, "UpdateRoleResponse": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/Role" } } }, "UpdateSAMLConnectionResponse": { "type": "object", "properties": { "samlConnection": { "$ref": "#/components/schemas/SAMLConnection" } } }, "UpdateSCIMAPIKeyResponse": { "type": "object", "properties": { "scimApiKey": { "$ref": "#/components/schemas/SCIMAPIKey" } } }, "UpdateUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" } } }, "User": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "owner": { "type": "boolean" }, "googleUserId": { "type": "string" }, "microsoftUserId": { "type": "string" }, "githubUserId": { "type": "string" }, "hasAuthenticatorApp": { "type": "boolean" }, "displayName": { "type": "string" }, "profilePictureUrl": { "type": "string" } } }, "UserInvite": { "type": "object", "properties": { "id": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "owner": { "type": "boolean" } } }, "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." }, "WhoamiResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/User" } } }, "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": "FrontendService" } ] }