> ## Documentation Index > Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code. > Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer. > For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them. > The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes. # Retire a developer app permanently > Refuses new installations and stops every installation's credentials at once; uninstalling every installation continues asynchronously after the response. It cannot be undone: enabling, disabling or updating a retired app returns 409. Retiring an already retired app at its current version returns 200 and runs the uninstall again. ## OpenAPI ````yaml https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/apps/{appId}/retire openapi: 3.1.0 info: title: Photon API version: 1.0.0 servers: - url: https://api.photon.codes security: [] paths: /v1/organizations/{organizationId}/apps/{appId}/retire: post: tags: - App Installation Configurations summary: Retire a developer app permanently description: >- Refuses new installations and stops every installation's credentials at once; uninstalling every installation continues asynchronously after the response. It cannot be undone: enabling, disabling or updating a retired app returns 409. Retiring an already retired app at its current version returns 200 and runs the uninstall again. operationId: retireAppInstallationConfig parameters: - description: Identifies one logical mutation across retries. in: header name: Idempotency-Key required: true schema: maxLength: 255 minLength: 1 pattern: ^[\x21-\x7e]{1,255}$ type: string - in: path name: organizationId required: true schema: type: string - in: path name: appId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RetireAppInstallationConfigRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RetireAppInstallationConfigResponse' description: App configuration after the change. headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '400': content: application/problem+json: schema: $ref: >- #/components/schemas/RetireAppInstallationConfigBadRequestProblem description: >- INVALID_ARGUMENT: Invalid Argument; IDEMPOTENCY_KEY_REQUIRED: Idempotency Key Required; IDEMPOTENCY_KEY_INVALID: Idempotency Key Invalid headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '401': content: application/problem+json: schema: $ref: '#/components/schemas/NotAuthenticatedProblem' description: 'NOT_AUTHENTICATED: Not Authenticated' headers: Link: description: Optional related resources. schema: type: string RateLimit: description: Optional rate limit information. schema: type: string RateLimit-Policy: description: Optional rate limit policy. schema: type: string Retry-After: description: Optional retry delay or HTTP date. schema: type: string WWW-Authenticate: required: true schema: type: string X-Request-ID: description: Application request identifier. schema: type: string '403': content: application/problem+json: schema: $ref: >- #/components/schemas/RetireAppInstallationConfigForbiddenProblem description: >- FORBIDDEN: Forbidden; RESOURCE_MISMATCH: Resource Mismatch FORBIDDEN: Forbidden; INSUFFICIENT_SCOPE: Insufficient Scope; ORGANIZATION_SSO_REQUIRED: Organization SSO Required headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: |- Links related to lifecycle or remediation documentation. Optional related resources. schema: type: string RateLimit: description: |- Current rate-limit state. Optional rate limit information. schema: type: string RateLimit-Policy: description: |- Rate-limit policy applied by the gateway. Optional rate limit policy. schema: type: string Retry-After: description: |- Delay before retrying, in seconds or as an HTTP date. Optional retry delay or HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: |- Identifier for this HTTP attempt. Application request identifier. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string '404': content: application/problem+json: schema: $ref: '#/components/schemas/AppInstallationConfigNotFoundProblem' description: >- APP_INSTALLATION_CONFIG_NOT_FOUND: App Installation Configuration Not Found headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '409': content: application/problem+json: schema: $ref: >- #/components/schemas/RetireAppInstallationConfigConflictProblem description: >- APP_INSTALLATION_CONFIG_VERSION_CONFLICT: App Installation Configuration Version Conflict; ACCOUNT_CLOSING: Account Is Closing; ORGANIZATION_AUTH_POLICY_CHANGED: Organization Authentication Policy Changed; ORGANIZATION_UNAVAILABLE: Organization Unavailable; APP_INSTALLATION_CONFIG_UNAVAILABLE: App Installation Configuration Unavailable headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '422': content: application/problem+json: schema: $ref: >- #/components/schemas/RetireAppInstallationConfigUnprocessableEntityProblem description: >- VALIDATION_FAILED: Request Validation Failed; IDEMPOTENCY_KEY_REUSED: Idempotency Key Reused headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '500': content: application/problem+json: schema: $ref: '#/components/schemas/InternalErrorProblem' description: 'INTERNAL_ERROR: Internal Server Error' headers: Link: description: Optional related resources. schema: type: string RateLimit: description: Optional rate limit information. schema: type: string RateLimit-Policy: description: Optional rate limit policy. schema: type: string Retry-After: description: Optional retry delay or HTTP date. schema: type: string X-Request-ID: description: Application request identifier. schema: type: string '502': content: application/problem+json: schema: $ref: '#/components/schemas/UpstreamFailureProblem' description: 'UPSTREAM_FAILURE: Upstream Service Failure' headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' '503': content: application/problem+json: schema: $ref: '#/components/schemas/UpstreamUnavailableProblem' description: 'UPSTREAM_UNAVAILABLE: Upstream Service Unavailable' headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: |- Links related to lifecycle or remediation documentation. Optional related resources. schema: type: string RateLimit: description: |- Current rate-limit state. Optional rate limit information. schema: type: string RateLimit-Policy: description: |- Rate-limit policy applied by the gateway. Optional rate limit policy. schema: type: string Retry-After: description: |- Delay before retrying, in seconds or as an HTTP date. Optional retry delay or HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: |- Identifier for this HTTP attempt. Application request identifier. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string '504': content: application/problem+json: schema: $ref: >- #/components/schemas/RetireAppInstallationConfigGatewayTimeoutProblem description: >- UPSTREAM_TIMEOUT: Upstream Service Timeout; REQUEST_TIMEOUT: Request Timeout headers: Deprecation: $ref: '#/components/headers/Deprecation' Idempotent-Replayed: $ref: '#/components/headers/Idempotent-Replayed' Link: $ref: '#/components/headers/Link' RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' Sunset: $ref: '#/components/headers/Sunset' X-Request-ID: $ref: '#/components/headers/X-Request-ID' X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' security: - accountServiceKey: [] components: schemas: RetireAppInstallationConfigRequest: additionalProperties: false properties: expectedVersion: pattern: ^[1-9][0-9]{0,18}$ type: string required: - expectedVersion type: object RetireAppInstallationConfigResponse: additionalProperties: false properties: appId: type: string createdAt: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ type: string createdByAccountId: type: string description: anyOf: - maxLength: 500 type: string - type: 'null' developerOrganizationId: type: string name: maxLength: 256 minLength: 1 type: string publicKeys: items: anyOf: - additionalProperties: false properties: alg: const: RS256 type: string e: maxLength: 11 pattern: ^[A-Za-z0-9_-]+$ type: string kid: pattern: ^[A-Za-z0-9._-]{1,128}$ type: string kty: const: RSA type: string 'n': maxLength: 1366 minLength: 342 pattern: ^[A-Za-z0-9_-]+$ type: string required: - alg - e - kid - kty - 'n' type: object - additionalProperties: false properties: alg: const: ES256 type: string crv: const: P-256 type: string kid: pattern: ^[A-Za-z0-9._-]{1,128}$ type: string kty: const: EC type: string x: maxLength: 43 minLength: 43 pattern: ^[A-Za-z0-9_-]+$ type: string 'y': maxLength: 43 minLength: 43 pattern: ^[A-Za-z0-9_-]+$ type: string required: - alg - crv - kid - kty - x - 'y' type: object maxItems: 16 minItems: 1 type: array redirectUris: items: maxLength: 4096 type: string maxItems: 32 minItems: 1 type: array requestedPermissions: items: type: string minItems: 1 type: array status: enum: - active - disabled - retired type: string updatedAt: format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ type: string updatedByAccountId: type: string version: pattern: ^[1-9][0-9]{0,18}$ type: string websiteUrl: anyOf: - maxLength: 2048 type: string - type: 'null' required: - appId - createdAt - createdByAccountId - description - developerOrganizationId - name - publicKeys - redirectUris - requestedPermissions - status - updatedAt - updatedByAccountId - version - websiteUrl type: object RetireAppInstallationConfigBadRequestProblem: oneOf: - $ref: '#/components/schemas/InvalidArgumentProblem' - $ref: '#/components/schemas/IdempotencyKeyRequiredProblem' - $ref: '#/components/schemas/IdempotencyKeyInvalidProblem' NotAuthenticatedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: NOT_AUTHENTICATED status: 401 title: Not Authenticated type: https://photon.codes/docs/problems/not-authenticated properties: code: const: NOT_AUTHENTICATED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 401 type: number title: const: Not Authenticated type: string type: const: https://photon.codes/docs/problems/not-authenticated type: string required: - code - status - title - type type: object RetireAppInstallationConfigForbiddenProblem: oneOf: - $ref: '#/components/schemas/ForbiddenProblem' - $ref: '#/components/schemas/InsufficientScopeProblem' - $ref: '#/components/schemas/OrganizationSsoRequiredProblem' - $ref: '#/components/schemas/ResourceMismatchProblem' AppInstallationConfigNotFoundProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: APP_INSTALLATION_CONFIG_NOT_FOUND status: 404 title: App Installation Configuration Not Found type: https://photon.codes/docs/problems/app-installation-config-not-found properties: code: const: APP_INSTALLATION_CONFIG_NOT_FOUND type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 404 type: number title: const: App Installation Configuration Not Found type: string type: const: https://photon.codes/docs/problems/app-installation-config-not-found type: string required: - code - status - title - type type: object RetireAppInstallationConfigConflictProblem: oneOf: - $ref: '#/components/schemas/AppInstallationConfigVersionConflictProblem' - $ref: '#/components/schemas/AccountClosingProblem' - $ref: '#/components/schemas/OrganizationAuthPolicyChangedProblem' - $ref: '#/components/schemas/OrganizationUnavailableProblem' - $ref: '#/components/schemas/AppInstallationConfigUnavailableProblem' RetireAppInstallationConfigUnprocessableEntityProblem: oneOf: - $ref: '#/components/schemas/ValidationFailedProblem' - $ref: '#/components/schemas/IdempotencyKeyReusedProblem' InternalErrorProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INTERNAL_ERROR status: 500 title: Internal Server Error type: https://photon.codes/docs/problems/internal-error properties: code: const: INTERNAL_ERROR type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 500 type: number title: const: Internal Server Error type: string type: const: https://photon.codes/docs/problems/internal-error type: string required: - code - status - title - type type: object UpstreamFailureProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: UPSTREAM_FAILURE status: 502 title: Upstream Service Failure type: https://photon.codes/docs/problems/upstream-failure properties: code: const: UPSTREAM_FAILURE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 502 type: number title: const: Upstream Service Failure type: string type: const: https://photon.codes/docs/problems/upstream-failure type: string required: - code - status - title - type type: object UpstreamUnavailableProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: UPSTREAM_UNAVAILABLE status: 503 title: Upstream Service Unavailable type: https://photon.codes/docs/problems/upstream-unavailable properties: code: const: UPSTREAM_UNAVAILABLE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 503 type: number title: const: Upstream Service Unavailable type: string type: const: https://photon.codes/docs/problems/upstream-unavailable type: string required: - code - status - title - type type: object RetireAppInstallationConfigGatewayTimeoutProblem: oneOf: - $ref: '#/components/schemas/UpstreamTimeoutProblem' - $ref: '#/components/schemas/RequestTimeoutProblem' InvalidArgumentProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INVALID_ARGUMENT status: 400 title: Invalid Argument type: https://photon.codes/docs/problems/invalid-argument properties: code: const: INVALID_ARGUMENT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 400 type: number title: const: Invalid Argument type: string type: const: https://photon.codes/docs/problems/invalid-argument type: string required: - code - status - title - type type: object IdempotencyKeyRequiredProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: IDEMPOTENCY_KEY_REQUIRED status: 400 title: Idempotency Key Required type: https://photon.codes/docs/problems/idempotency-key-required properties: code: const: IDEMPOTENCY_KEY_REQUIRED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 400 type: number title: const: Idempotency Key Required type: string type: const: https://photon.codes/docs/problems/idempotency-key-required type: string required: - code - status - title - type type: object IdempotencyKeyInvalidProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: IDEMPOTENCY_KEY_INVALID status: 400 title: Idempotency Key Invalid type: https://photon.codes/docs/problems/idempotency-key-invalid properties: code: const: IDEMPOTENCY_KEY_INVALID type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 400 type: number title: const: Idempotency Key Invalid type: string type: const: https://photon.codes/docs/problems/idempotency-key-invalid type: string required: - code - status - title - type type: object JsonValue: anyOf: - type: string - type: number - type: boolean - type: 'null' - items: $ref: '#/components/schemas/JsonValue' type: array - additionalProperties: $ref: '#/components/schemas/JsonValue' propertyNames: type: string type: object ForbiddenProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: FORBIDDEN status: 403 title: Forbidden type: https://photon.codes/docs/problems/forbidden properties: code: const: FORBIDDEN type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Forbidden type: string type: const: https://photon.codes/docs/problems/forbidden type: string required: - code - status - title - type type: object InsufficientScopeProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: INSUFFICIENT_SCOPE status: 403 title: Insufficient Scope type: https://photon.codes/docs/problems/insufficient-scope properties: code: const: INSUFFICIENT_SCOPE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Insufficient Scope type: string type: const: https://photon.codes/docs/problems/insufficient-scope type: string required: - code - status - title - type type: object OrganizationSsoRequiredProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: ORGANIZATION_SSO_REQUIRED status: 403 title: Organization SSO Required type: https://photon.codes/docs/problems/organization-sso-required properties: code: const: ORGANIZATION_SSO_REQUIRED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Organization SSO Required type: string type: const: https://photon.codes/docs/problems/organization-sso-required type: string required: - code - status - title - type type: object ResourceMismatchProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: RESOURCE_MISMATCH status: 403 title: Resource Mismatch type: https://photon.codes/docs/problems/resource-mismatch properties: code: const: RESOURCE_MISMATCH type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 403 type: number title: const: Resource Mismatch type: string type: const: https://photon.codes/docs/problems/resource-mismatch type: string required: - code - status - title - type type: object AppInstallationConfigVersionConflictProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: APP_INSTALLATION_CONFIG_VERSION_CONFLICT status: 409 title: App Installation Configuration Version Conflict type: >- https://photon.codes/docs/problems/app-installation-config-version-conflict properties: code: const: APP_INSTALLATION_CONFIG_VERSION_CONFLICT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: App Installation Configuration Version Conflict type: string type: const: >- https://photon.codes/docs/problems/app-installation-config-version-conflict type: string required: - code - status - title - type type: object AccountClosingProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: ACCOUNT_CLOSING status: 409 title: Account Is Closing type: https://photon.codes/docs/problems/account-closing properties: code: const: ACCOUNT_CLOSING type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: Account Is Closing type: string type: const: https://photon.codes/docs/problems/account-closing type: string required: - code - status - title - type type: object OrganizationAuthPolicyChangedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: ORGANIZATION_AUTH_POLICY_CHANGED status: 409 title: Organization Authentication Policy Changed type: https://photon.codes/docs/problems/organization-auth-policy-changed properties: code: const: ORGANIZATION_AUTH_POLICY_CHANGED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: Organization Authentication Policy Changed type: string type: const: https://photon.codes/docs/problems/organization-auth-policy-changed type: string required: - code - status - title - type type: object OrganizationUnavailableProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: ORGANIZATION_UNAVAILABLE status: 409 title: Organization Unavailable type: https://photon.codes/docs/problems/organization-unavailable properties: code: const: ORGANIZATION_UNAVAILABLE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: Organization Unavailable type: string type: const: https://photon.codes/docs/problems/organization-unavailable type: string required: - code - status - title - type type: object AppInstallationConfigUnavailableProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: APP_INSTALLATION_CONFIG_UNAVAILABLE status: 409 title: App Installation Configuration Unavailable type: https://photon.codes/docs/problems/app-installation-config-unavailable properties: code: const: APP_INSTALLATION_CONFIG_UNAVAILABLE type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 409 type: number title: const: App Installation Configuration Unavailable type: string type: const: >- https://photon.codes/docs/problems/app-installation-config-unavailable type: string required: - code - status - title - type type: object ValidationFailedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: VALIDATION_FAILED issues: - code: invalid_type location: json message: Expected a string. path: /name status: 422 title: Request Validation Failed type: https://photon.codes/docs/problems/validation-failed properties: code: const: VALIDATION_FAILED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string issues: items: $ref: '#/components/schemas/ValidationIssue' type: array remediation: not: {} requestId: minLength: 1 type: string status: const: 422 type: number title: const: Request Validation Failed type: string type: const: https://photon.codes/docs/problems/validation-failed type: string required: - issues - code - status - title - type type: object IdempotencyKeyReusedProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: IDEMPOTENCY_KEY_REUSED status: 422 title: Idempotency Key Reused type: https://photon.codes/docs/problems/idempotency-key-reused properties: code: const: IDEMPOTENCY_KEY_REUSED type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 422 type: number title: const: Idempotency Key Reused type: string type: const: https://photon.codes/docs/problems/idempotency-key-reused type: string required: - code - status - title - type type: object UpstreamTimeoutProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: UPSTREAM_TIMEOUT status: 504 title: Upstream Service Timeout type: https://photon.codes/docs/problems/upstream-timeout properties: code: const: UPSTREAM_TIMEOUT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 504 type: number title: const: Upstream Service Timeout type: string type: const: https://photon.codes/docs/problems/upstream-timeout type: string required: - code - status - title - type type: object RequestTimeoutProblem: additionalProperties: $ref: '#/components/schemas/JsonValue' example: code: REQUEST_TIMEOUT status: 504 title: Request Timeout type: https://photon.codes/docs/problems/request-timeout properties: code: const: REQUEST_TIMEOUT type: string detail: minLength: 1 type: string instance: minLength: 1 type: string remediation: not: {} requestId: minLength: 1 type: string status: const: 504 type: number title: const: Request Timeout type: string type: const: https://photon.codes/docs/problems/request-timeout type: string required: - code - status - title - type type: object ValidationIssue: additionalProperties: false properties: code: minLength: 1 type: string location: $ref: '#/components/schemas/ValidationLocation' message: minLength: 1 type: string path: type: string required: - code - location - message - path type: object ValidationLocation: enum: - body - cookie - form - header - json - param - query type: string headers: Deprecation: description: >- RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`. schema: pattern: ^@-?[0-9]+$ type: string Idempotent-Replayed: description: True when this response was replayed from an earlier attempt. schema: type: boolean Link: description: Links related to lifecycle or remediation documentation. schema: type: string RateLimit: description: Current rate-limit state. schema: type: string RateLimit-Policy: description: Rate-limit policy applied by the gateway. schema: type: string Retry-After: description: Delay before retrying, in seconds or as an HTTP date. schema: type: string Sunset: description: >- RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`. schema: pattern: >- ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$ type: string X-Request-ID: description: Identifier for this HTTP attempt. schema: type: string X-Trace-ID: description: >- Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request. schema: pattern: ^(?!0{32}$)[0-9a-f]{32}$ type: string securitySchemes: accountServiceKey: description: >- Account Service Key, prefixed with `pho_ask_`, sent as `Authorization: Bearer `. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.