On this page
Username Parameter Moved from Path to Query
The ULRs with the username parameter in the path have been changed to move the parameter to query. This has been done due to a special security vulnerability related to some special characters being used in the path.
Due to this change, the following URLs have been moved:
From | To |
/osmc/admin/ldaps/{ldapId}/import/{username} | /osmc/admin/ldaps/{ldapId}/import |
/osmc/admin/ldaps/{ldapId}/import/{username}/usergroups | /osmc/admin/ldaps/{ldapId}/importas/usergroups |
/osmc/admin/ldaps/{ldapId}/import/{username}/users | /osmc/admin/ldaps/{ldapId}/importas/users |
/osmc/admin/locks/{username} | /osmc/admin/locks |
/osmc/admin/roles/{roleId}/users/{username} | /osmc/admin/roles/{roleId}/users |
/osmc/admin/users/{username} | /osmc/admin/user |
/osmc/admin/users/{username}/resourcebranchreadonlyall | /osmc/admin/user/resourcebranchreadonlyall |
/osmc/admin/users/{username}/resources/{resourceId}/branches/readonly | /osmc/admin/user/resources/{resourceId}/branches/readonly |
/osmc/admin/users/{username}/roles | /osmc/admin/user/roles |
/osmc/resources/{resourceId}/roles/{roleId}/users/{username} | /osmc/resources/{resourceId}/roles/{roleId}/users |
/osmc/workspaces/{workspaceId}/resources/{resourceId}/roles/{roleId}/users/{username} | /osmc/workspaces/{workspaceId}/resources/{resourceId}/roles/{roleId}/users |
/osmc/workspaces/{workspaceId}/roles/{roleId}/users/{username} | /osmc/workspaces/{workspaceId}/roles/{roleId}/users |
New URLs
Read-only Branch Deletion
New API for read-only branch deletion to comply with HTTP standards. Uses HTTP PUT method.
- /osmc/admin/user/resources/{resourceId}/branches/readonlydelete
- /osmc/admin/usergroups/{usergroupId}/resources/{resourceId}/branches/readonlydelete
Webhooks
Webhook CRUD.
- /osmc/admin/webhooks
- /osmc/admin/webhooks/{webhookId}
- /osmc/admin/webhooks/{webhookId}/status
Removed URLs
Deprecated in Previous Version
- /osmc/admin/tsl
New Data Types
WebhookTriggerSimple
Name | Type | Remark |
type | ENUM (one of: “all”, “list”, “commit”, “any_tag”) | The trigger type. |
WebhookTriggerResourceTags
Name | Type | Remark |
type | ENUM (one of: “tags”) | The trigger type. |
value | Array of String | The commit tags that trigger the invocation of the webhook. |
WebhookTrigger
One of: WebhookTriggerSimple, WebhookTriggerResourceTags.
SetOfWebhookTrigger
Name | Type | Remark |
type | ENUM (one of: “list”) | The trigger type. |
value | Array of WebhookTrigger | Arbitrary set of webhook triggers. |
WebhookScopeAll
Name | Type | Remark |
type | ENUM (one of: “all”) | The scope type. |
WebhookScopeResource
Name | Type | Remark |
type | ENUM (one of: “resource”) | The scope type. |
value | UUID | The ID of the resource that constitutes the scope. |
WebhookScopeResourcesInCategory
Name | Type | Remark |
type | ENUM (one of: “resource_in_category”) | The scope type. |
value | UUID | The ID of the category that constitutes the scope. |
WebhookScope
One of: WebhookScopeAll, WebhookScopeResource, WebhookScopeResourcesInCategory.
WebhookAuthenticationNone
Name | Type | Remark |
type | ENUM (one of: “none”) | The authentication type. |
WebhookAuthenticationBasic
Name | Type | Remark |
type | ENUM (one of: “type”) | The authentication type. |
authentication_username | String | The username. |
authentication_password | String | The password. |
WebhookAuthentication
One of: WebhookAuthenticationNone, WebhookAuthenticationBasic.
Webhook
Name | Type | Remark |
webhookId | UUID | The webhook ID. |
trigger | One of: WebhookTrigger, SetOfWebhookTrigger | The trigger. |
scope | WebhookScope | The scope. |
enabled | Boolean | Is the webhook enabled. |
type | ENUM (one of: “http”) | The webhook type. |
endpoint | String | The webhook endpoint (URL). |
authentication | WebhookAuthentication | The authentication. |
WebhookUpdate
Name | Type | Remark |
trigger | One of: WebhookTrigger, SetOfWebhookTrigger | The trigger. |
scope | WebhookScope | The scope. |
enabled | Boolean | Is the webhook enabled. |
type | ENUM (one of: “http”) | The webhook type. |
endpoint | String | The webhook endpoint (URL). |
authentication | WebhookAuthentication | The authentication. |
WebhookCreateResult
Name | Type | Remark |
webhookId | UUID | The ID of the created webhook. |
WebhookStatus
Name | Type | Remark |
enabled | Boolean | Is the webhook enabled. |