{ "openapi": "3.1.0", "info": { "title": "IdRa admin and SCIM API", "version": "2026-10-31", "description": "Part of /api/admin, and the SCIM server. /api/v1 is in openapi.json. Limits of this file: Responses aren't described. A write with no fields listed has no validated body, or checks it inside the handler. The JSON file has the full schemas. `/api/admin` paths aren't versioned. They serve IdRa's console and change with it. [`/api/v1`](/docs/api-reference) is the surface built for compatibility. Permissions are what the route's gate asks of the caller's role. Handlers can refuse further, for example an admin limited to certain groups or apps, or an action only super admins may take, and that isn't listed. SCIM shapes follow RFC 7643. Supported features are what `/ServiceProviderConfig` answers." }, "servers": [ { "url": "https://{org}", "variables": { "org": { "default": "your-org.idra.team" } } } ], "components": { "securitySchemes": { "ssws": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "`SSWS `, with a token from Security → API → Tokens. It acts with its creator's current role." }, "session": { "type": "apiKey", "in": "cookie", "name": "session", "description": "An admin's MFA-verified console session. Operations marked x-idra-fresh-mfa need a second factor within 15 minutes." }, "scimBearer": { "type": "http", "scheme": "bearer", "description": "A connection's token from Directory → Directory Integrations." } } }, "paths": { "/api/auth/scim/v2/Groups": { "post": { "summary": "Create SCIM Group", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string", "const": "urn:ietf:params:scim:schemas:core:2.0:Group" } }, "externalId": { "type": "string", "minLength": 1 }, "displayName": { "type": "string", "minLength": 1 }, "members": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1 }, "type": { "type": "string" } }, "required": [ "value" ] } } }, "required": [ "schemas", "displayName" ] } } } }, "responses": { "default": { "description": "Not described here." } } }, "get": { "summary": "List SCIM Groups", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "startIndex", "in": "query", "schema": { "type": [ "string", "number" ] } }, { "name": "count", "in": "query", "schema": { "type": [ "string", "number" ] } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/auth/scim/v2/Groups/{groupId}": { "delete": { "summary": "Delete SCIM Group", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "get": { "summary": "Get SCIM Group", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Patch SCIM Group", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string", "const": "urn:ietf:params:scim:api:messages:2.0:PatchOp" } }, "Operations": { "type": "array", "items": { "type": "object", "properties": { "op": { "default": "replace", "type": "string" }, "path": { "type": "string" }, "value": {} } } } }, "required": [ "schemas", "Operations" ] } } } }, "responses": { "default": { "description": "Not described here." } } }, "put": { "summary": "Replace SCIM Group", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string", "const": "urn:ietf:params:scim:schemas:core:2.0:Group" } }, "externalId": { "type": "string", "minLength": 1 }, "displayName": { "type": "string", "minLength": 1 }, "members": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1 }, "type": { "type": "string" } }, "required": [ "value" ] } } }, "required": [ "schemas", "displayName" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/auth/scim/v2/Users": { "post": { "summary": "Create SCIM User", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "string" } }, "userName": { "type": "string", "minLength": 1, "maxLength": 512 }, "externalId": { "type": "string", "minLength": 1, "maxLength": 1024 }, "displayName": { "type": "string", "minLength": 1, "maxLength": 1024 }, "name": { "type": "object", "properties": { "formatted": { "type": "string", "minLength": 1, "maxLength": 1024 }, "givenName": { "type": "string", "minLength": 1, "maxLength": 256 }, "familyName": { "type": "string", "minLength": 1, "maxLength": 256 }, "middleName": { "type": "string", "minLength": 1, "maxLength": 256 }, "honorificPrefix": { "type": "string", "minLength": 1, "maxLength": 256 }, "honorificSuffix": { "type": "string", "minLength": 1, "maxLength": 256 } } }, "emails": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "maxLength": 254, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "primary": { "type": "boolean" }, "type": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "value" ] } }, "title": { "type": "string", "minLength": 1, "maxLength": 1024 }, "userType": { "type": "string", "minLength": 1, "maxLength": 256 }, "preferredLanguage": { "type": "string", "minLength": 1, "maxLength": 256 }, "locale": { "type": "string", "minLength": 1, "maxLength": 256 }, "timezone": { "type": "string", "minLength": 1, "maxLength": 256 }, "phoneNumbers": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "type": "string", "minLength": 1, "maxLength": 256 }, "primary": { "type": "boolean" } }, "required": [ "value" ] } }, "addresses": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "formatted": { "type": "string", "minLength": 1, "maxLength": 1024 }, "streetAddress": { "type": "string", "minLength": 1, "maxLength": 1024 }, "locality": { "type": "string", "minLength": 1, "maxLength": 256 }, "region": { "type": "string", "minLength": 1, "maxLength": 256 }, "postalCode": { "type": "string", "minLength": 1, "maxLength": 256 }, "country": { "type": "string", "minLength": 1, "maxLength": 256 }, "type": { "type": "string", "minLength": 1, "maxLength": 256 }, "primary": { "type": "boolean" } } } }, "roles": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 1024 }, "display": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "type": "string", "minLength": 1, "maxLength": 256 }, "primary": { "type": "boolean" } }, "required": [ "value" ] } }, "entitlements": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 1024 }, "display": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "type": "string", "minLength": 1, "maxLength": 256 }, "primary": { "type": "boolean" } }, "required": [ "value" ] } }, "active": { "type": "boolean" }, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "type": "object", "properties": { "employeeNumber": { "type": "string", "minLength": 1, "maxLength": 256 }, "costCenter": { "type": "string", "minLength": 1, "maxLength": 256 }, "organization": { "type": "string", "minLength": 1, "maxLength": 1024 }, "division": { "type": "string", "minLength": 1, "maxLength": 1024 }, "department": { "type": "string", "minLength": 1, "maxLength": 1024 }, "manager": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 256 }, "$ref": { "type": "string", "minLength": 1, "maxLength": 2048 }, "displayName": { "type": "string", "minLength": 1, "maxLength": 1024 } } }, { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 256 }, "$ref": { "type": "string", "minLength": 1, "maxLength": 2048 }, "displayName": { "type": "string", "minLength": 1, "maxLength": 1024 } } } } ] } } } }, "required": [ "schemas", "userName" ] } } } }, "responses": { "default": { "description": "Not described here." } } }, "get": { "summary": "List SCIM Users", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "startIndex", "in": "query", "schema": { "type": [ "string", "number" ] } }, { "name": "count", "in": "query", "schema": { "type": [ "string", "number" ] } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/auth/scim/v2/Users/{userId}": { "delete": { "summary": "Delete SCIM User", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "get": { "summary": "Get SCIM User", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Patch SCIM User", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "string", "const": "urn:ietf:params:scim:api:messages:2.0:PatchOp" } }, "Operations": { "type": "array", "items": { "type": "object", "properties": { "op": { "default": "replace", "type": "string" }, "path": { "type": "string" }, "value": {} } } } }, "required": [ "schemas", "Operations" ] } } } }, "responses": { "default": { "description": "Not described here." } } }, "put": { "summary": "Replace SCIM User", "tags": [ "SCIM" ], "security": [ { "scimBearer": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, { "name": "excludedAttributes", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schemas": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "string" } }, "userName": { "type": "string", "minLength": 1, "maxLength": 512 }, "externalId": { "type": "string", "minLength": 1, "maxLength": 1024 }, "displayName": { "type": "string", "minLength": 1, "maxLength": 1024 }, "name": { "type": "object", "properties": { "formatted": { "type": "string", "minLength": 1, "maxLength": 1024 }, "givenName": { "type": "string", "minLength": 1, "maxLength": 256 }, "familyName": { "type": "string", "minLength": 1, "maxLength": 256 }, "middleName": { "type": "string", "minLength": 1, "maxLength": 256 }, "honorificPrefix": { "type": "string", "minLength": 1, "maxLength": 256 }, "honorificSuffix": { "type": "string", "minLength": 1, "maxLength": 256 } } }, "emails": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "maxLength": 254, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "primary": { "type": "boolean" }, "type": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "value" ] } }, "title": { "type": "string", "minLength": 1, "maxLength": 1024 }, "userType": { "type": "string", "minLength": 1, "maxLength": 256 }, "preferredLanguage": { "type": "string", "minLength": 1, "maxLength": 256 }, "locale": { "type": "string", "minLength": 1, "maxLength": 256 }, "timezone": { "type": "string", "minLength": 1, "maxLength": 256 }, "phoneNumbers": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "type": "string", "minLength": 1, "maxLength": 256 }, "primary": { "type": "boolean" } }, "required": [ "value" ] } }, "addresses": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "formatted": { "type": "string", "minLength": 1, "maxLength": 1024 }, "streetAddress": { "type": "string", "minLength": 1, "maxLength": 1024 }, "locality": { "type": "string", "minLength": 1, "maxLength": 256 }, "region": { "type": "string", "minLength": 1, "maxLength": 256 }, "postalCode": { "type": "string", "minLength": 1, "maxLength": 256 }, "country": { "type": "string", "minLength": 1, "maxLength": 256 }, "type": { "type": "string", "minLength": 1, "maxLength": 256 }, "primary": { "type": "boolean" } } } }, "roles": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 1024 }, "display": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "type": "string", "minLength": 1, "maxLength": 256 }, "primary": { "type": "boolean" } }, "required": [ "value" ] } }, "entitlements": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 1024 }, "display": { "type": "string", "minLength": 1, "maxLength": 1024 }, "type": { "type": "string", "minLength": 1, "maxLength": 256 }, "primary": { "type": "boolean" } }, "required": [ "value" ] } }, "active": { "type": "boolean" }, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "type": "object", "properties": { "employeeNumber": { "type": "string", "minLength": 1, "maxLength": 256 }, "costCenter": { "type": "string", "minLength": 1, "maxLength": 256 }, "organization": { "type": "string", "minLength": 1, "maxLength": 1024 }, "division": { "type": "string", "minLength": 1, "maxLength": 1024 }, "department": { "type": "string", "minLength": 1, "maxLength": 1024 }, "manager": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 256 }, "$ref": { "type": "string", "minLength": 1, "maxLength": 2048 }, "displayName": { "type": "string", "minLength": 1, "maxLength": 1024 } } }, { "minItems": 1, "maxItems": 1, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 256 }, "$ref": { "type": "string", "minLength": 1, "maxLength": 2048 }, "displayName": { "type": "string", "minLength": 1, "maxLength": 1024 } } } } ] } } } }, "required": [ "schemas", "userName" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/auth/scim/v2/ServiceProviderConfig": { "get": { "summary": "Get SCIM service provider configuration", "tags": [ "SCIM" ], "security": [], "responses": { "default": { "description": "Not described here." } } } }, "/api/auth/scim/v2/Schemas": { "get": { "summary": "List SCIM schemas", "tags": [ "SCIM" ], "security": [], "responses": { "default": { "description": "Not described here." } } } }, "/api/auth/scim/v2/Schemas/{schemaId}": { "get": { "summary": "Get a SCIM schema", "tags": [ "SCIM" ], "security": [], "parameters": [ { "name": "schemaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/auth/scim/v2/ResourceTypes": { "get": { "summary": "List SCIM resource types", "tags": [ "SCIM" ], "security": [], "responses": { "default": { "description": "Not described here." } } } }, "/api/auth/scim/v2/ResourceTypes/{resourceTypeId}": { "get": { "summary": "Get a SCIM resource type", "tags": [ "SCIM" ], "security": [], "parameters": [ { "name": "resourceTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/groups": { "get": { "summary": "List groups", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:read" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a group", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:write" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 1000 } }, "required": [ "name" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/groups/{id}": { "get": { "summary": "Get a group", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Update a group", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 1000 } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete a group", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/groups/{id}/members": { "post": { "summary": "Add members", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:members" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userIds": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "userIds" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/groups/{id}/members/{userId}": { "delete": { "summary": "Remove a member", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:members" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/groups/{id}/rules": { "get": { "summary": "List a group's membership rules", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a membership rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "attribute": { "type": "string", "pattern": "^(email|name|profile\\.[a-zA-Z][a-zA-Z0-9_]*)$" }, "op": { "type": "string", "enum": [ "eq", "in", "startsWith", "endsWith", "contains" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "name", "attribute", "op", "value" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/groups/{id}/rules/{ruleId}": { "patch": { "summary": "Update a membership rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "attribute": { "type": "string", "pattern": "^(email|name|profile\\.[a-zA-Z][a-zA-Z0-9_]*)$" }, "op": { "type": "string", "enum": [ "eq", "in", "startsWith", "endsWith", "contains" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 1000 }, "active": { "type": "boolean" } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete a membership rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/groups/{id}/rules/apply": { "post": { "summary": "Queue a run of a group's membership rules", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "group:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/user-search": { "get": { "summary": "Search people by name or email", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:list" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "default": 20, "type": "number", "maximum": 100 } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people": { "get": { "summary": "List people", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:list" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "staged", "provisioned", "active", "recovery", "suspended", "deprovisioned", "awaiting" ] } }, { "name": "limit", "in": "query", "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "offset", "in": "query", "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:create" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 100 }, "email": { "type": "string", "maxLength": 254, "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "profile": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "groupIds": { "default": [], "type": "array", "items": { "type": "string" } }, "activate": { "default": false, "type": "boolean" } }, "required": [ "firstName", "lastName", "email" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}": { "get": { "summary": "Get a person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:get" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Update a person's name and profile", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "person:edit" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "profile": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "profile" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/sessions": { "get": { "summary": "List a person's sessions", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "session:list" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/activate": { "post": { "summary": "Activate a person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "person:edit" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/reactivate": { "post": { "summary": "Reactivate a deprovisioned person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "person:edit", "user:ban" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/deactivate": { "post": { "summary": "Deactivate a person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:ban", "user:delete" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/suspend": { "post": { "summary": "Suspend a person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:ban" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/unsuspend": { "post": { "summary": "Unsuspend a person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:ban" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/reset-password": { "post": { "summary": "Send a person a password reset", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:set-password" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/reset-authenticators": { "post": { "summary": "Reset a person's authenticators", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:set-password" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/clear-sessions": { "post": { "summary": "End a person's sessions", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "session:revoke" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/delete": { "post": { "summary": "Delete a deprovisioned person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:delete" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/people/{id}/lifecycle/unlock": { "post": { "summary": "Clear a person's password lockout", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:ban" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/profile-attributes": { "get": { "summary": "List profile attributes", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:list" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a profile attribute", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:update" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "enumValues": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1 } }, "required": { "type": "boolean" }, "uniqueValues": { "type": "boolean" }, "userPermission": { "type": "string", "enum": [ "hide", "read_only", "read_write" ] }, "key": { "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9_]{0,63}$" }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "date", "enum" ] } }, "required": [ "label", "key", "type" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/profile-attributes/{key}": { "patch": { "summary": "Update a profile attribute", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:update" ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "enumValues": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1 } }, "required": { "type": "boolean" }, "uniqueValues": { "type": "boolean" }, "userPermission": { "type": "string", "enum": [ "hide", "read_only", "read_write" ] } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete a profile attribute", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:update" ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/admins": { "get": { "summary": "List admins and their roles", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:list" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Assign an admin role", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:set-role" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "role": { "type": "string", "enum": [ "super_admin", "org_admin", "app_admin", "help_desk", "read_only", "group_admin", "group_membership_admin", "report_admin", "mobile_admin", "api_access_admin", "access_request_admin", "pam_admin" ] }, "targets": { "default": [], "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "group", "app", "client" ] }, "id": { "type": "string" } }, "required": [ "kind", "id" ] } } }, "required": [ "userId", "role" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/admins/{userId}/roles/{role}/targets": { "put": { "summary": "Set the targets of an admin's role", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:set-role" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "group", "app", "client" ] }, "id": { "type": "string" } }, "required": [ "kind", "id" ] } } }, "required": [ "targets" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/directory/admins/{userId}/roles/{role}": { "delete": { "summary": "Remove an admin role", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:set-role" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/apps/catalog": { "get": { "summary": "List the app catalog", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/apps": { "get": { "summary": "List apps", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "oidc", "saml", "bookmark", "gateway" ] } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "active", "inactive" ] } } ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create an app", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateKey": { "type": "string" }, "type": { "type": "string", "enum": [ "oidc", "saml", "bookmark", "gateway" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 1000 }, "logoUrl": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" }, "visible": { "type": "boolean" }, "oidc": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "web", "spa", "native", "service" ] }, "redirectUris": { "default": [], "type": "array", "items": { "type": "string", "maxLength": 2048, "format": "uri" } } }, "required": [ "kind" ] }, "assignMe": { "type": "boolean" } }, "required": [ "name" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/apps/{id}": { "get": { "summary": "Get an app", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Update an app", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "visible": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "inactive" ] } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete an app", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/apps/{id}/oidc": { "get": { "summary": "Get an app's OIDC settings", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Update an app's OIDC settings", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "redirectUris": { "type": "array", "items": { "type": "string", "maxLength": 2048, "format": "uri" } }, "postLogoutRedirectUris": { "type": "array", "items": { "type": "string", "format": "uri" } }, "grantTypes": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:token-exchange", "urn:ietf:params:oauth:grant-type:jwt-bearer" ] } }, "consentRequired": { "type": "boolean" }, "requirePkce": { "type": "boolean" }, "tokenEndpointAuthMethod": { "type": "string", "enum": [ "client_secret_basic", "client_secret_post", "private_key_jwt" ] }, "jwks": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "keys" ] }, "jwksUri": { "type": "string", "format": "uri" }, "requireDpop": { "type": "boolean" }, "backchannelLogoutUri": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "string", "const": "" } ] }, "clientCredentialsScopes": { "type": "array", "items": { "type": "string", "minLength": 1 } } } } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/apps/{id}/oidc/rotate-secret": { "post": { "summary": "Rotate an app's client secret", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/apps/{id}/assignments": { "get": { "summary": "List an app's assignments", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Assign people and groups to an app", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userIds": { "default": [], "type": "array", "items": { "type": "string" } }, "groupIds": { "default": [], "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/apps/{id}/users.csv": { "get": { "summary": "Download an app's assigned people as CSV", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/apps/{id}/assignments/{assignmentId}": { "delete": { "summary": "Remove an assignment", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assignmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/client-registration": { "get": { "summary": "Get dynamic client registration settings", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:read" ], "responses": { "default": { "description": "Not described here." } } }, "put": { "summary": "Turn dynamic client registration on or off", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write", "app:write" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/client-registration/tokens": { "post": { "summary": "Create a registration token", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write", "app:write" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64 }, "expiresInDays": { "type": "integer", "minimum": 1, "maximum": 90 } }, "required": [ "name", "expiresInDays" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/client-registration/tokens/{id}": { "delete": { "summary": "Delete a registration token", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write", "app:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/servers": { "get": { "summary": "List authorization servers", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create an authorization server", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:write" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "allowedScopes": { "type": "array", "items": { "type": "string", "pattern": "^[\\w.:/-]+$" } }, "accessTokenTtl": { "anyOf": [ { "type": "integer", "minimum": 60, "maximum": 86400 }, { "type": "null" } ] }, "customClaims": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number", "boolean" ] } }, { "type": "null" } ] }, "disabled": { "type": "boolean" }, "identifier": { "type": "string", "format": "uri" } }, "required": [ "name", "identifier" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/servers/{id}": { "get": { "summary": "Get an authorization server", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Update an authorization server", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "allowedScopes": { "type": "array", "items": { "type": "string", "pattern": "^[\\w.:/-]+$" } }, "accessTokenTtl": { "anyOf": [ { "type": "integer", "minimum": 60, "maximum": 86400 }, { "type": "null" } ] }, "customClaims": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number", "boolean" ] } }, { "type": "null" } ] }, "disabled": { "type": "boolean" } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete an authorization server", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/servers/{id}/clients": { "post": { "summary": "Allow a client on an authorization server", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1 } }, "required": [ "clientId" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/servers/{id}/clients/{clientId}": { "delete": { "summary": "Remove a client from a server", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/servers/{id}/rules": { "post": { "summary": "Create an access rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "priority": { "type": "integer", "minimum": 0, "maximum": 10000 }, "enabled": { "type": "boolean" }, "conditions": { "type": "object", "properties": { "clients": { "type": "array", "items": { "type": "string" } }, "grantTypes": { "type": "array", "items": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:token-exchange", "urn:ietf:params:oauth:grant-type:jwt-bearer" ] } }, "groups": { "type": "array", "items": { "type": "string" } } } }, "action": { "type": "object", "properties": { "access": { "type": "string", "enum": [ "allow", "deny" ] }, "allowedScopes": { "type": "array", "items": { "type": "string", "pattern": "^[\\w.:/-]+$" } } }, "required": [ "access" ] } }, "required": [ "name", "priority", "enabled", "conditions", "action" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/rules/{ruleId}": { "patch": { "summary": "Update an access rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:write" ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "priority": { "type": "integer", "minimum": 0, "maximum": 10000 }, "enabled": { "type": "boolean" }, "conditions": { "type": "object", "properties": { "clients": { "type": "array", "items": { "type": "string" } }, "grantTypes": { "type": "array", "items": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:token-exchange", "urn:ietf:params:oauth:grant-type:jwt-bearer" ] } }, "groups": { "type": "array", "items": { "type": "string" } } } }, "action": { "type": "object", "properties": { "access": { "type": "string", "enum": [ "allow", "deny" ] }, "allowedScopes": { "type": "array", "items": { "type": "string", "pattern": "^[\\w.:/-]+$" } } }, "required": [ "access" ] } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete an access rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:write" ], "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/servers/{id}/preview": { "post": { "summary": "Preview which rule a token request matches", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "api_access:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1 }, "grantType": { "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:token-exchange", "urn:ietf:params:oauth:grant-type:jwt-bearer" ] }, "scopes": { "type": "array", "items": { "type": "string" } }, "userId": { "type": "string" } }, "required": [ "clientId", "grantType", "scopes" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/tokens/service-apps": { "get": { "summary": "List service apps and their grants", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/tokens/service-apps/{id}": { "put": { "summary": "Set a service app's scope grants", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write", "policy:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "string", "enum": [ "okta.users.read", "okta.users.manage", "okta.groups.read", "okta.groups.manage", "okta.logs.read", "okta.apps.read", "okta.apps.manage", "okta.authorizationServers.read", "okta.authorizationServers.manage", "okta.policies.read", "okta.policies.manage", "okta.networkZones.read", "okta.networkZones.manage", "okta.eventHooks.read", "okta.eventHooks.manage", "okta.devices.read", "okta.devices.manage", "okta.logStreams.read", "okta.logStreams.manage", "okta.inlineHooks.read", "okta.inlineHooks.manage", "okta.roles.read", "okta.roles.manage", "okta.userRisk.read", "okta.userRisk.manage", "okta.appGrants.read", "okta.appGrants.manage" ] } } }, "required": [ "scopes" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/tokens": { "get": { "summary": "List API tokens", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create an API token", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 32 }, "expiresInDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "allowedZoneIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "name" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/api-access/tokens/{id}": { "delete": { "summary": "Delete an API token", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/provisioning/apps/{appId}": { "get": { "summary": "Get an app's provisioning settings", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "put": { "summary": "Set an app's provisioning settings", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "baseUrl": { "anyOf": [ { "type": "string", "maxLength": 2000, "format": "uri" }, { "type": "string", "const": "" } ] }, "token": { "type": "string", "minLength": 1, "maxLength": 4000 }, "createUsers": { "type": "boolean" }, "updateUsers": { "type": "boolean" }, "deactivateUsers": { "type": "boolean" }, "pushGroups": { "type": "boolean" }, "mappings": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "scim": { "type": "string", "pattern": "^(urn:[\\w.:-]+:)?[a-zA-Z][\\w.]*$" }, "value": { "type": "string", "pattern": "^(email|name|profile\\.[a-zA-Z][a-zA-Z0-9_]*)$" } }, "required": [ "scim", "value" ] } } }, "required": [ "enabled", "baseUrl", "createUsers", "updateUsers", "deactivateUsers", "pushGroups", "mappings" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/provisioning/apps/{appId}/test": { "post": { "summary": "Test a SCIM base URL and token", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "baseUrl": { "type": "string", "maxLength": 2000, "format": "uri" }, "token": { "type": "string", "minLength": 1 } } } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/provisioning/apps/{appId}/push": { "post": { "summary": "Push everyone assigned to the app", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/provisioning/apps/{appId}/users/{userId}/push": { "post": { "summary": "Push one person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/provisioning/apps/{appId}/groups": { "post": { "summary": "Add a pushed group", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "minLength": 1 } }, "required": [ "groupId" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/provisioning/apps/{appId}/groups/{groupId}/push": { "post": { "summary": "Push one group", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/provisioning/apps/{appId}/groups/{groupId}": { "delete": { "summary": "Stop pushing a group", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/scim": { "get": { "summary": "List inbound SCIM connections", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:list" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a connection and its bearer token", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:create", "user:update", "user:ban" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "name" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/scim/{connectionId}/rotate": { "post": { "summary": "Rotate a connection's bearer token", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:create", "user:update", "user:ban" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/scim/{connectionId}/revoke": { "post": { "summary": "Revoke a connection's bearer token", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "user:create", "user:update", "user:ban" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/identity-providers/routing-rules": { "get": { "summary": "List routing rules", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a routing rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "priority": { "default": 100, "type": "integer", "minimum": 0, "maximum": 100000 }, "enabled": { "default": true, "type": "boolean" }, "conditions": { "type": "object", "properties": { "domains": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } }, "zones": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } }, "clients": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } }, "platforms": { "maxItems": 10, "type": "array", "items": { "type": "string", "enum": [ "macOS", "Windows", "iOS", "Android", "Linux", "ChromeOS" ] } } }, "additionalProperties": false }, "providerId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "name", "conditions", "providerId" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/identity-providers/routing-rules/{id}": { "patch": { "summary": "Update a routing rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "priority": { "default": 100, "type": "integer", "minimum": 0, "maximum": 100000 }, "enabled": { "default": true, "type": "boolean" }, "conditions": { "type": "object", "properties": { "domains": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } }, "zones": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } }, "clients": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } }, "platforms": { "maxItems": 10, "type": "array", "items": { "type": "string", "enum": [ "macOS", "Windows", "iOS", "Android", "Linux", "ChromeOS" ] } } }, "additionalProperties": false }, "providerId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete a routing rule", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/identity-providers/domain-proofs": { "get": { "summary": "List domain proofs", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Start proving a domain", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "pattern": "^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$" } }, "required": [ "domain" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/identity-providers/domain-proofs/{domain}/verify": { "post": { "summary": "Check a domain proof", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/identity-providers/domain-proofs/{domain}": { "delete": { "summary": "Delete a domain proof", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/identity-providers": { "get": { "summary": "List identity providers", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Add an identity provider", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "providerId": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,62}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "domains": { "default": [], "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "pattern": "^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$" } }, "jit": { "default": false, "type": "boolean" }, "linkExisting": { "default": false, "type": "boolean" }, "type": { "type": "string", "const": "social" }, "preset": { "type": "string", "enum": [ "google", "microsoft" ] }, "tenantId": { "type": "string", "pattern": "^[a-zA-Z0-9.-]{1,100}$" }, "clientId": { "type": "string", "minLength": 1, "maxLength": 500 }, "clientSecret": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "providerId", "name", "type", "preset", "clientId", "clientSecret" ] }, { "type": "object", "properties": { "providerId": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,62}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "domains": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "pattern": "^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$" } }, "jit": { "default": true, "type": "boolean" }, "linkExisting": { "default": false, "type": "boolean" }, "type": { "type": "string", "const": "oidc" }, "issuer": { "type": "string", "maxLength": 2000, "format": "uri" }, "discoveryUrl": { "type": "string", "maxLength": 2000, "format": "uri" }, "clientId": { "type": "string", "minLength": 1, "maxLength": 500 }, "clientSecret": { "type": "string", "minLength": 1, "maxLength": 2000 }, "scopes": { "default": [ "openid", "email", "profile" ], "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "providerId", "name", "domains", "type", "issuer", "clientId", "clientSecret" ] }, { "type": "object", "properties": { "providerId": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,62}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "domains": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "pattern": "^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$" } }, "jit": { "default": true, "type": "boolean" }, "linkExisting": { "default": false, "type": "boolean" }, "type": { "type": "string", "const": "saml" }, "metadataXml": { "type": "string", "maxLength": 100000 }, "entryPoint": { "type": "string", "maxLength": 2000, "format": "uri" }, "idpEntityId": { "type": "string", "minLength": 1, "maxLength": 1000 }, "cert": { "type": "string", "maxLength": 20000 }, "signingKey": { "type": "string", "minLength": 1, "maxLength": 20000 }, "decryptionKey": { "type": "string", "minLength": 1, "maxLength": 20000 }, "idpInitiated": { "default": false, "type": "boolean" }, "slo": { "default": false, "type": "boolean" } }, "required": [ "providerId", "name", "domains", "type" ] } ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/identity-providers/{providerId}": { "get": { "summary": "Get an identity provider", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:read" ], "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Update an identity provider", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "domains": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "pattern": "^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$" } }, "jit": { "type": "boolean" }, "idpInitiated": { "type": "boolean" }, "slo": { "type": "boolean" }, "attributeMap": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" }, "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 200 } }, "groupClaim": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "groupMap": { "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 500 }, "groupId": { "type": "string", "minLength": 1 } }, "required": [ "value", "groupId" ] } } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete an identity provider", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/identity-providers/{providerId}/linking": { "put": { "summary": "Set account linking", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "policy:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "linkExisting": { "type": "boolean" }, "linkDomains": { "maxItems": 20, "type": "array", "items": { "type": "string", "pattern": "^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$" } }, "trustEmail": { "type": "boolean" } }, "required": [ "linkExisting", "linkDomains" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/webhooks": { "get": { "summary": "List webhooks", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a webhook", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "maxLength": 2000, "format": "uri" }, "eventTypes": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "pattern": "^(\\*|[a-z][a-z0-9_]*(\\.[a-z0-9_]+)*\\.?)$" } }, "filter": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "format": { "type": "string", "enum": [ "idra", "okta" ] }, "headers": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[A-Za-z0-9-]{1,100}$" }, "value": { "type": "string", "maxLength": 4096 }, "secret": { "type": "boolean" } }, "required": [ "key", "value" ] } } }, "required": [ "name", "url", "eventTypes" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/webhooks/{id}": { "get": { "summary": "Get a webhook", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:read" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "patch": { "summary": "Update a webhook", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "maxLength": 2000, "format": "uri" }, "eventTypes": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "pattern": "^(\\*|[a-z][a-z0-9_]*(\\.[a-z0-9_]+)*\\.?)$" } }, "filter": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "format": { "type": "string", "enum": [ "idra", "okta" ] }, "headers": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[A-Za-z0-9-]{1,100}$" }, "value": { "type": "string", "maxLength": 4096 }, "secret": { "type": "boolean" } }, "required": [ "key", "value" ] } }, "enabled": { "type": "boolean" } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete a webhook", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/integrations/webhooks/{id}/test": { "post": { "summary": "Send a webhook a test delivery", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/streams": { "get": { "summary": "List log streams", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a log stream", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "type": { "type": "string", "enum": [ "splunk", "http" ] }, "url": { "type": "string", "maxLength": 2000, "format": "uri" }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 }, "header": { "type": "string", "pattern": "^[A-Za-z0-9-]{1,100}$" } }, "required": [ "name", "type", "url", "token" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/streams/{id}": { "patch": { "summary": "Update a log stream", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "maxLength": 2000, "format": "uri" }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 }, "header": { "type": "string", "pattern": "^[A-Za-z0-9-]{1,100}$" }, "enabled": { "type": "boolean" } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete a log stream", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/streams/{id}/test": { "post": { "summary": "Send a log stream a test event", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/inline-hooks": { "get": { "summary": "List inline hooks", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create an inline hook", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "type": { "type": "string", "enum": [ "token", "saml", "registration", "user_import", "password_import", "telephony" ] }, "url": { "type": "string", "maxLength": 2000, "format": "uri" }, "keyId": { "type": "string", "minLength": 1 }, "onFailure": { "type": "string", "enum": [ "deny", "continue" ] }, "auth": { "anyOf": [ { "type": "object", "properties": { "header": { "type": "string", "pattern": "^[A-Za-z0-9-]{1,100}$" }, "value": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "header", "value" ] }, { "type": "null" } ] } }, "required": [ "name", "type", "url", "keyId" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/inline-hooks/{id}": { "patch": { "summary": "Update an inline hook", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "maxLength": 2000, "format": "uri" }, "keyId": { "type": "string", "minLength": 1 }, "onFailure": { "type": "string", "enum": [ "deny", "continue" ] }, "auth": { "anyOf": [ { "type": "object", "properties": { "header": { "type": "string", "pattern": "^[A-Za-z0-9-]{1,100}$" }, "value": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "header", "value" ] }, { "type": "null" } ] }, "enabled": { "type": "boolean" } } } } } }, "responses": { "default": { "description": "Not described here." } } }, "delete": { "summary": "Delete an inline hook", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/inline-hooks/{id}/test": { "post": { "summary": "Call an inline hook with a test request", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/hook-keys": { "get": { "summary": "List hook keys", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:read" ], "responses": { "default": { "description": "Not described here." } } }, "post": { "summary": "Create a hook key", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "x-idra-fresh-mfa": true, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "name" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/hook-keys/{id}": { "delete": { "summary": "Delete a hook key", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/logs/integrity/verify": { "post": { "summary": "Verify the System Log's integrity", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "report:read" ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/saml/apps/{appId}": { "get": { "summary": "Get an app's SAML settings", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } }, "put": { "summary": "Set an app's SAML settings", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "string", "minLength": 1, "maxLength": 1024 }, "acsUrl": { "type": "string", "maxLength": 1024, "format": "uri" }, "acsUrls": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 1024, "format": "uri" }, "index": { "type": "integer", "minimum": 0, "maximum": 65535 } }, "required": [ "url", "index" ], "additionalProperties": false } }, "audience": { "type": "string", "maxLength": 1024 }, "defaultRelayState": { "type": "string", "maxLength": 1024 }, "nameIdFormat": { "type": "string", "enum": [ "emailAddress", "unspecified", "persistent", "transient", "x509SubjectName", "windowsDomainQualifiedName", "kerberos" ] }, "nameIdAttribute": { "type": "string", "pattern": "^(id|email|name|groups|profile\\.[\\w-]+)$" }, "nameIdExpression": { "type": "string", "minLength": 1, "maxLength": 1024 }, "attributes": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "value": { "type": "string", "pattern": "^(id|email|name|groups|profile\\.[\\w-]+)$" } }, "required": [ "name", "value" ] } }, "signResponse": { "type": "boolean" }, "signatureAlgorithm": { "type": "string", "enum": [ "rsa-sha256", "rsa-sha512" ] }, "spCertificate": { "type": "string", "maxLength": 20000 }, "requireSignedRequests": { "type": "boolean" }, "honorForceAuthn": { "type": "boolean" }, "honorAuthnContext": { "type": "boolean" } }, "required": [ "entityId", "acsUrl", "nameIdFormat", "nameIdAttribute", "attributes", "signResponse" ], "additionalProperties": false } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/saml/apps/{appId}/preview": { "post": { "summary": "Preview the assertion for a person", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:read", "user:get" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object", "properties": { "entityId": { "type": "string", "minLength": 1, "maxLength": 1024 }, "acsUrl": { "type": "string", "maxLength": 1024, "format": "uri" }, "acsUrls": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 1024, "format": "uri" }, "index": { "type": "integer", "minimum": 0, "maximum": 65535 } }, "required": [ "url", "index" ], "additionalProperties": false } }, "audience": { "type": "string", "maxLength": 1024 }, "defaultRelayState": { "type": "string", "maxLength": 1024 }, "nameIdFormat": { "type": "string", "enum": [ "emailAddress", "unspecified", "persistent", "transient", "x509SubjectName", "windowsDomainQualifiedName", "kerberos" ] }, "nameIdAttribute": { "type": "string", "pattern": "^(id|email|name|groups|profile\\.[\\w-]+)$" }, "nameIdExpression": { "type": "string", "minLength": 1, "maxLength": 1024 }, "attributes": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "value": { "type": "string", "pattern": "^(id|email|name|groups|profile\\.[\\w-]+)$" } }, "required": [ "name", "value" ] } }, "signResponse": { "type": "boolean" }, "signatureAlgorithm": { "type": "string", "enum": [ "rsa-sha256", "rsa-sha512" ] }, "spCertificate": { "type": "string", "maxLength": 20000 }, "requireSignedRequests": { "type": "boolean" }, "honorForceAuthn": { "type": "boolean" }, "honorAuthnContext": { "type": "boolean" } }, "required": [ "entityId", "acsUrl", "nameIdFormat", "nameIdAttribute", "attributes", "signResponse" ], "additionalProperties": false }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "config" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/saml/apps/{appId}/import": { "post": { "summary": "Read SAML settings from service provider metadata XML", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "app:write" ], "parameters": [ { "name": "appId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "xml": { "type": "string", "minLength": 1, "maxLength": 500000 } }, "required": [ "xml" ] } } } }, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/saml/keys": { "get": { "summary": "List signing keys", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:read" ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/saml/keys/saml/rotate": { "post": { "summary": "Rotate the SAML signing key", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "x-idra-fresh-mfa": true, "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/saml/keys/saml/{id}/retire": { "post": { "summary": "Retire a SAML signing key", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "x-idra-fresh-mfa": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Not described here." } } } }, "/api/admin/saml/keys/oidc/rotate": { "post": { "summary": "Rotate the OIDC signing key", "tags": [ "Admin" ], "security": [ { "ssws": [] }, { "session": [] } ], "x-idra-permissions": [ "settings:write" ], "x-idra-fresh-mfa": true, "responses": { "default": { "description": "Not described here." } } } } } }