List OIDC custom property inclusions for an enterprise

1 parameter

enterprisestringrequired

The slug version of the enterprise name.

3 status codes

200A JSON array of OIDC custom property inclusions

custom_property_namestringrequired

The name of the custom property that is included in the OIDC token

inclusion_sourcestringrequired

Whether the inclusion was defined at the organization or enterprise level

Allowed:organizationenterprise

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.repo.list({ enterprise: "example" });

[
  {
    "custom_property_name": "environment",
    "inclusion_source": "enterprise"
  },
  {
    "custom_property_name": "team",
    "inclusion_source": "enterprise"
  }
]

Request

Response

Errors