Config for tool's authentication method.
| Field | Type | Required | Description |
|---|---|---|---|
is_on_prem |
Optional[bool] | ➖ | Whether or not this tool is hosted on-premise. |
uses_central_auth |
Optional[bool] | ➖ | Whether or not this uses central auth. |
type |
Optional[models.AuthConfigType] | ➖ | The type of authentication being used. Use 'OAUTH_*' when Glean calls an external API (e.g., Jira) on behalf of a user to obtain an OAuth token. 'OAUTH_ADMIN' utilizes an admin token for external API calls on behalf all users. 'OAUTH_USER' uses individual user tokens for external API calls. 'DWD' refers to domain wide delegation. |
grant_type |
Optional[models.GrantType] | ➖ | The type of grant type being used. |
status |
Optional[models.AuthConfigStatus] | ➖ | Auth status of the tool. |
client_url |
Optional[str] | ➖ | The URL where users will be directed to start the OAuth flow. |
scopes |
List[str] | ➖ | A list of strings denoting the different scopes or access levels required by the tool. |
audiences |
List[str] | ➖ | A list of strings denoting the different audience which can access the tool. |
authorization_url |
Optional[str] | ➖ | The OAuth provider's endpoint, where access tokens are requested. |
resource |
Optional[str] | ➖ | The OAuth 2.0 Resource Indicator (RFC 8707) for the protected resource. Discovered from Protected Resource Metadata (RFC 9728) during DCR. Included in authorization and token exchange requests when present. |
token_endpoint_auth_method |
Optional[models.TokenEndpointAuthMethod] | ➖ | The OAuth 2.0 token endpoint authentication method (RFC 7591). Determines how the client authenticates when exchanging an authorization code for a token. Values use lowercase to match the OAuth 2.0 wire format (RFC 7591 Section 2). |
auth_header_type |
Optional[models.AuthHeaderType] | ➖ | Defines the header structure for sending the API key or token to the server. Defaults to AUTHORIZATION_BEARER. Select the specific header format the server expects for transmitting the key. |
last_authorized_at |
date | ➖ | The time the tool was last authorized in ISO format (ISO 8601). |