Skip to Content

POST /auth/get

Get Auth

Get auth information using the canonical shared auth operation.

Request Body (GetAuthApiRequest)

FieldTypeRequiredDescription
idstringNoAuth identifier
auth_idstringNoLegacy alias for auth identifier
draft_idstringNoUUID of the draft to load
snapshot_keystringNoCache snapshot key for consistent reads across related requests
namesapp__infra__auth__types__SectionFilterNoFilter options for names section
descriptionsapp__infra__auth__types__SectionFilterNoFilter options for descriptions section
flagsapp__infra__auth__types__SectionFilterNoFilter options for flags section
departmentsapp__infra__auth__types__SectionFilterNoFilter options for departments section
protocolsapp__infra__auth__types__SectionFilterNoFilter options for protocols section
slugsapp__infra__auth__types__SectionFilterNoFilter options for slugs section
itemsapp__infra__auth__types__SectionFilterNoFilter options for items section

Response (GetAuthApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the acting user
auth_existsbooleanNoWhether the auth provider exists
can_editbooleanNoWhether the actor can edit this auth
disabled_reasonstringNoReason editing is disabled, if any
group_idstringNoGroup UUID for draft collaboration
draft_namestringNoImmutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches.
show_ai_generatebooleanNoWhether any auth resource supports AI generate
basic_show_ai_generatebooleanNoWhether to show AI generate button
pending_idsstring[]NoPending resource identifiers when available
namesAuthNameResource[]NoName resources
descriptionsAuthDescriptionResource[]NoDescription resources
flagsAuthFlagResource[]NoFlag resources (one per flags_resource row, value=true/false)
departmentsAuthDepartmentResource[]NoDepartment resources
protocolsAuthProtocolResource[]NoProtocol resources
slugsAuthSlugResource[]NoSlug resources
itemsAuthItemResource[]NoAuth item resources
Last updated on