Patch
/sys/v1/plugins/{plugin_id}
Change a plugin's properties, such as name, description, code, group membership, etc.
Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Path parameters
plugin_id
string (uuid) Required
Body parameters
object
default_group
string (uuid) | null
description
string | null
enabled
boolean | null
name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
plugin_type
string
Valid values[
"STANDARD",
"IMPERSONATING",
"CUSTOMALGORITHM"
]
signature
string | null
source
OneOf
object
object
repo_url
string Required
plugin_name
string Required
version
string Required
Pattern^\d+.\d+$
object
object
language
string Required
Valid values[
"LUA"
]
code
string Required
add_groups
Array of string | null
string (uuid)
del_groups
Array of string | null
string (uuid)
mod_groups
Array of string | null
string (uuid)
Responses
2XX
Success result
object
acct_id
string (uuid)
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
creator
OneOf
PrincipalVariantApp
object (PrincipalVariantApp)
app
string (uuid)
PrincipalVariantUser
object (PrincipalVariantUser)
user
string (uuid)
PrincipalVariantPlugin
object (PrincipalVariantPlugin)
plugin
string (uuid)
PrincipalVariantUserViaApp
object (PrincipalVariantUserViaApp)
userviaapp
object
user_id
string (uuid)
scopes
Array of string (OauthScope)
string
Valid values[
"app",
"openid",
"email",
"profile"
]
string
string
Valid values[
"system"
]
string
string
Valid values[
"unregistereduser"
]
default_group
string (uuid)
description
string | null
enabled
boolean
lastrun_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
lastupdated_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
legacy_access
boolean
name
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
plugin_id
string (uuid)
plugin_type
string
Valid values[
"STANDARD",
"IMPERSONATING",
"CUSTOMALGORITHM"
]
source
OneOf
object
object
repo_url
string
name
string
version
string
Pattern^\d+.\d+$
language
string
Valid values[
"LUA"
]
code
string
object
object
language
string
Valid values[
"LUA"
]
code
string
groups
Array of string
string (uuid)