ApiPrincipalContext
@nmi-agro/fdm-source / fdm-api/src / ApiPrincipalContext
Interface: ApiPrincipalContext
Defined in: fdm-api/src/types.ts:4
Describes the authenticated API principal stored on each request.
Properties
apiKeyId
apiKeyId:
string
Defined in: fdm-api/src/types.ts:8
Identifier of the API key that was presented with the request.
channel
channel:
"api"
Defined in: fdm-api/src/types.ts:12
Channel marker used to distinguish API-key authentication from other auth flows.
effectivePrincipalId
effectivePrincipalId:
string
Defined in: fdm-api/src/types.ts:14
Effective principal identifier used for downstream authorization checks and data access.
keyName
keyName:
string|null
Defined in: fdm-api/src/types.ts:10
Optional human-readable name assigned to the API key.
userId
userId:
string
Defined in: fdm-api/src/types.ts:6
Identifier of the user that owns the authenticated API key.