General

To create an identity, head to your Organization Settings > Access Control > Machine Identities and press Create identity.

When creating an identity, you specify an organization level role for it to assume; you can configure roles in Organization Settings > Access Control > Organization Roles.

Now input a few details for your new identity. Here’s some guidance for each field:

• Name (required): A friendly name for the identity.
• Role (required): A role from the Organization Roles tab for the identity to assume. The organization role assigned will determine what organization level resources this identity can have access to.

Once you’ve created an identity, you’ll be redirected to a page where you can manage the identity.

Since the identity has been configured with Universal Auth by default, you should re-configure it to use OIDC Auth instead. To do this, press to edit the Authentication section, remove the existing Universal Auth configuration, and add a new OIDC Auth configuration onto the identity.

Here’s some more guidance on each field:

• OIDC Discovery URL: The URL used to retrieve the OpenID Connect configuration from the identity provider. This will be used to fetch the public key needed for verifying the provided JWT.
• Issuer: The unique identifier of the identity provider issuing the JWT. This value is used to verify the iss (issuer) claim in the JWT to ensure the token is issued by a trusted provider.
• CA Certificate: The PEM-encoded CA cert for establishing secure communication with the Identity Provider endpoints.
• Subject: The expected principal that is the subject of the JWT. The sub (subject) claim in the JWT should match this value.
• Audiences: A list of intended recipients. This value is checked against the aud (audience) claim in the token. The token’s aud claim should match at least one of the audiences for it to be valid.
• Claims: Additional information or attributes that should be present in the JWT for it to be valid.
• Access Token TTL (default is 2592000 equivalent to 30 days): The lifetime for an acccess token in seconds. This value will be referenced at renewal time.
• Access Token Max TTL (default is 2592000 equivalent to 30 days): The maximum lifetime for an acccess token in seconds. This value will be referenced at renewal time.
• Access Token Max Number of Uses (default is 0): The maximum number of times that an access token can be used; a value of 0 implies infinite number of uses.
• Access Token Trusted IPs: The IPs or CIDR ranges that access tokens can be used from. By default, each token is given the 0.0.0.0/0, allowing usage from any network address.

To enable the identity to access project-level resources such as secrets within a specific project, you should add it to that project.

To do this, head over to the project you want to add the identity to and go to Project Settings > Access Control > Machine Identities and press Add identity.

Next, select the identity you want to add to the project and the project level role you want to allow it to assume. The project role assigned will determine what project level resources this identity can have access to.

To access the Infisical API as the identity, you need to fetch an identity token from an identity provider and make a request to the /api/v1/auth/oidc-auth/login endpoint in exchange for an access token.

We provide an example below of how authentication is done with Infisical using OIDC. It is a snippet from the official Github secrets action.

Sample usage

export const oidcLogin = async ({ identityId, domain, oidcAudience }) => {
    const idToken = await core.getIDToken(oidcAudience);

    const loginData = querystring.stringify({
        identityId,
        jwt: idToken,
    });

    try {
        const response = await axios({
        method: "post",
        url: `${domain}/api/v1/auth/oidc-auth/login`,
        headers: {
            "Content-Type": "application/x-www-form-urlencoded",
        },
        data: loginData,
        });

        return response.data.accessToken;
    } catch (err) {
        core.error("Error:", err.message);
        throw err;
    }
};

Sample OIDC login response

{
"accessToken": "...",
"expiresIn": 7200,
"accessTokenMaxTTL": 43244
"tokenType": "Bearer"
}