Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 7.9 KB

platformoauthclient.md

File metadata and controls

19 lines (15 loc) · 7.9 KB

PlatformOAuthClient

An OAuth client that an admin created for the workspace.

Fields

Field Type Required Description
client_id str ✔️ The OAuth client_id that the client sends to the authorization server. This is not the ID that usage records and usage limits use; see ai_gateway.usage_client_id.
display_name str ✔️ The client name that admins gave the client, or client_id when it has no name.
registration_type models.PlatformOAuthClientRegistrationType ✔️ How an OAuth client was registered.
client_type Optional[models.PlatformOAuthClientType] ➖ Whether an OAuth client can keep a secret.
grant_types List[models.PlatformOAuthGrantType] ✔️ The OAuth grant types that the client can use.
token_endpoint_auth_method Optional[models.PlatformOAuthTokenEndpointAuthMethod] ➖ How an OAuth client authenticates to the token endpoint.
redirect_uris List[str] ✔️ The redirect URIs that the client can use.
is_enabled bool ✔️ Whether the client is enabled. A client that an admin disabled cannot authenticate.
created_at date ➖ When the client was created. Absent when it is not known.
ai_gateway Optional[models.PlatformOAuthClientAiGateway] ➖ LLM Gateway details of an OAuth client.