# The FederationPolicy object

## Attributes

- `name` (string, Output only, Immutable)
  Resource name for the federation policy. Example values include
   `accounts/<account-id>/federationPolicies/my-federation-policy` for Account Federation Policies, and
   `accounts/<account-id>/servicePrincipals/<service-principal-id>/federationPolicies/my-federation-policy`
   for Service Principal Federation Policies. Typically an output parameter, which does not need to be
   specified in create or update requests. If specified in a request, must match the value in the
   request URL.
- `description` (string)
  Description of the federation policy.
  Example: `My federation policy description.`
- `oidc_policy` (object)
  - `issuer` (string)
    The required token issuer, as specified in the 'iss' claim of federated tokens.
    Example: `https://myidp.example.com/oidc`
  - `subject` (string)
    The required token subject, as specified in the subject claim of federated tokens.
     Must be specified for service principal federation policies. Must not be specified
     for account federation policies.
  - `audiences` (array of string)
    The allowed token audiences, as specified in the 'aud' claim of federated tokens.
     The audience identifier is intended to represent the recipient of the token.
     Can be any non-empty string value. As long as the audience in the token matches
     at least one audience in the policy, the token is considered a match. If audiences
     is unspecified, defaults to your Databricks account id.
    Example: `databricks`
  - `subject_claim` (string)
    The claim that contains the subject of the token. If unspecified, the default value
     is 'sub'.
    Example: `sub`
  - `jwks_uri` (string)
    URL of the public keys used to validate the signature of federated tokens, in
     JWKS format. Most use cases should not need to specify this field. If jwks_uri
     and jwks_json are both unspecified (recommended), Databricks automatically
     fetches the public keys from your issuer’s well known endpoint. Databricks
     strongly recommends relying on your issuer’s well known endpoint for discovering
     public keys.
  - `jwks_json` (string)
    The public keys used to validate the signature of federated tokens, in JWKS format.
     Most use cases should not need to specify this field. If jwks_uri and jwks_json
     are both unspecified (recommended), Databricks automatically fetches the public
     keys from your issuer’s well known endpoint. Databricks strongly recommends
     relying on your issuer’s well known endpoint for discovering public keys.
- `create_time` (string, Output only, Immutable)
  Creation time of the federation policy.
- `update_time` (string, Output only)
  Last update time of the federation policy.
- `uid` (string, Output only, Immutable)
  Unique, immutable id of the federation policy.
- `service_principal_id` (int64, Output only, Immutable)
  The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies.
- `policy_id` (string, Output only, Immutable)
  The ID of the federation policy. Output only.

## Example

```json
{
  "name": "string",
  "description": "My federation policy description.",
  "oidc_policy": {
    "issuer": "https://myidp.example.com/oidc",
    "subject": "string",
    "audiences": "databricks",
    "subject_claim": "sub",
    "jwks_uri": "string",
    "jwks_json": "string"
  },
  "create_time": "string",
  "update_time": "string",
  "uid": "string",
  "service_principal_id": 0,
  "policy_id": "string"
}
```