From 340086fd0a5284f4598d9d283a452d814608cd4e Mon Sep 17 00:00:00 2001 From: Max Hausch Date: Tue, 13 Feb 2024 21:44:30 +0100 Subject: [PATCH] bump: Update zerotier-central-api openapi --- zerotier-central-api/openapi.json | 103 +++++++++++++++++++++++++++--- 1 file changed, 94 insertions(+), 9 deletions(-) diff --git a/zerotier-central-api/openapi.json b/zerotier-central-api/openapi.json index 75a2774..cc6d22e 100644 --- a/zerotier-central-api/openapi.json +++ b/zerotier-central-api/openapi.json @@ -1115,6 +1115,10 @@ }, "nullable": true }, + "ssoConfig": { + "$ref": "#/components/schemas/NetworkSSOConfig", + "nullable": true + }, "tags": { "type": "array", "items": { @@ -1132,6 +1136,55 @@ } } }, + "NetworkSSOConfig": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "example": true, + "readOnly": false, + "description": "SSO enabled/disabled on network" + }, + "mode": { + "type": "string", + "example": "default", + "description": "SSO mode. One of: `default`, `email`, `group`", + "readOnly": false + }, + "clientId": { + "type": "string", + "example": "some-client-id", + "description": "SSO client ID. Client ID must be already configured in the Org", + "readOnly": false + }, + "issuer": { + "type": "string", + "example": "https://example.com/oidc", + "description": "URL of the OIDC issuer", + "readOnly": true + }, + "provider": { + "type": "string", + "example": "keycloak", + "description": "Provider type", + "readOnly": true + }, + "authorizationEndpoint": { + "type": "string", + "description": "Authorization URL endpoint", + "readOnly": true + }, + "allowList": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "List of email addresses or group memberships that may SSO auth onto the network", + "readOnly": false + } + } + }, "Member": { "type": "object", "properties": { @@ -1198,14 +1251,23 @@ "type": "integer", "format": "int64", "readOnly": true, - "description": "Last seen time of the member. Note: This data is considered ephemeral and may be reset to 0 at any time without warning.", + "description": "Last seen time of the member (milliseconds since epoch). Note: This data is considered ephemeral and may be reset to 0 at any time without warning.", + "example": 1612993673254, + "nullable": true, + "deprecated": true + }, + "lastSeen": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Time the member last checked in with the network controller in milliseconds since epoch. Note: This data is considered ephemeral and may be reset to 0 at any time without warning.", "example": 1612993673254, "nullable": true }, "physicalAddress": { "type": "string", "readOnly": true, - "description": "IP address the member last spoke to the controller via. Note: This data is considered ephemeral and may be reset to 0 at any time without warning.", + "description": "IP address the member last spoke to the controller via (milliseconds since epoch). Note: This data is considered ephemeral and may be reset to 0 at any time without warning.", "example": "8.8.8.8", "nullable": true }, @@ -1450,14 +1512,36 @@ }, "ssoConfig": { "type": "object", - "$ref": "#/components/schemas/SsoConfig", + "$ref": "#/components/schemas/OrgSsoConfig", "description": "Organization wide SSO configuration" } } }, - "SsoConfig": { + "OrgSsoConfig": { "type": "object", "properties": { + "enabled": { + "type": "boolean", + "example": true, + "description": "Enabled flag for SSO" + }, + "issuers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoIssuer", + "description": "list of configured OIDC issuers" + } + } + } + }, + "SsoIssuer": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "example": "keycloak", + "description": "OIDC Provider (one of: default, authelia, auth0, azure, keycloak, okta, onelogin)" + }, "clientId": { "type": "string", "example": "oidc-client-id", @@ -1468,10 +1552,11 @@ "example": "https://example.com/oidc/auth", "description": "OIDC Issuer URL" }, - "enabled": { - "type": "boolean", - "example": true, - "description": "Enabled flag for SSO" + "authorization_endpoint": { + "type": "string", + "example": "https://example.com/oidc/auth/endpoint", + "description": "authorization endpoint", + "readOnly": true } } }, @@ -1814,7 +1899,7 @@ }, "security": [ { - "bearerAuth": [] + "tokenAuth": [] } ] }