-
Notifications
You must be signed in to change notification settings - Fork 189
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into remove-tasklist-graphql
- Loading branch information
Showing
138 changed files
with
6,484 additions
and
6,148 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
docs/apis-tools/camunda-api-rest/specifications/add-user-to-group.api.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| id: add-user-to-group | ||
| title: "Assign a user to a group" | ||
| description: "Assigns a user to a group." | ||
| sidebar_label: "Assign a user to a group" | ||
| hide_title: true | ||
| hide_table_of_contents: true | ||
| api: eJztWMFy2zYQ/RUMTsmUJuXESR3eNI6duk1Sjy23B8cHEFiJSECAAUDLHA7/vbMAKSuS7GQ8PeqgoUgC+7DY9wDwddSzhaP5Df1gTVPT24SaGizz0uhzQXPKhLh2YGcmvk+oAMetrLEBzenUObnQjjDSOLDEG8LIAlumXzRNaM0sq8CDRYiOalYBzWlo8Be0NKESg9TMlzShFr430oKgubcNbCLNSoiRyTdoU5pQx0uoGM076tsaw0rtYQGWJnRubMV8fPT2iPZ9ssLGYT4HOqT3DORbDO5qox047PFq8govjwAsmSMsTCkI4hrOwbl5o1SLM+vHGUhpn9CjyeSJQNw0ShBtPClgFTH9oj8ZC0SAZ1I5wiyQ2po7KUAQqQPAOFhSGNHGInKjPWiPaKyuleSBHVltTaGg+u2rQ+hubVY2KEIuYssBl5jiK3BPmCOxYRHRby7PTsi7oze/374ova9dnmXL5TK1c34AQnpjU2MXmZ1z/GG7lymZlWCBVKwNaQohEZMpzKoG6yU44mrgci75OIPDsAmWLuY3FDEOC0m76vxQ4lWpnbdSL9Yr3Vi5LQtyfXlOpADt5byVerENHfrMWaMwBitM4/NCMf0Na+ulVztBN1FcU1XMtsTMdwD0CXWe+cb9lKmvX23FRib9MZtdkBiCcCOAzI0lvpRuBMIkKqll1VQ0P5pMElqx+3j3djLpMSZW/Bcy0QTua8V0oNZmOlKT6oG3ITGpnWea/1+VMVYu5CZuigvHWAs6kPh9zKjv+6DB19t8PzO2kEKADvQkuLSA80S6IEemlFmCSPe62utqr6tHdXW0e2+LBwBjh91S+jLuivIONO7OYQNFmc1No/ci24tsL7InRPbuqZPotrakI0xZYKJ9OKP+eCzdy20vt73cdsvtza7vtakmOMsWeQjWGksM5421IMiylCqEx2/AEXs4TO6/y/Za22vtMa31Ca3Alwbtq9q4QB20eXKahX3KZd3oQPUZbnYu6wZbqEd3B+zdaFg1VtGcdlFCfZ5lXWmc7/OuNtb32R3W545ZyQoVWYmvo9RGCinDmSrjMLZLiS/QmRpTPGFVowUjx+Ty9GpGPjAPS9aGqUXIH0MfT44nO6Ni00ciTi/OScwwEnFtcRjDosp3ho2NfyVw8L0c8MZK315htzg9BTALdtpgNVYEGfBCdLyPjWgy/DkbafPnv7NQeannJnQfGLA9EKwKWBdHPkkPt9l2cR5Ew01VNTqsnHoRzzxsLTGuGucxoYQqyUG7wOvBSRybfYxvyD8RkRymWJTInHHBXEhfNkXKTZXx2G11LZQpsopJnQ0QLjuZfrr+/H568PH85PTz1enBYTpJ/b0PySOhK6bXxhEt2G0HdjPp7mHD+JltOxTGw73PasWkRqqEjLpBSjfRxHU0ofmanRvUhM9Gm/U2GSRxQ7uuYA6urep7fPy9AdvS/Ob2QUFBckI6/C9oPmfKbXqx60m8uBxc25dkyxzemcHwkOk2yFY1eEcT+g3adVca3eJnj2LdJ37GIMZ562/7hJbABNgwK/HtlHOo/Vq/R/d91N9qEbz4+wqV8x9I3zlT | ||
| sidebar_class_name: "post api-method" | ||
| info_path: docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api | ||
| custom_edit_url: null | ||
| hide_send_button: true | ||
| --- | ||
|
|
||
| import ApiTabs from "@theme/ApiTabs"; | ||
| import DiscriminatorTabs from "@theme/DiscriminatorTabs"; | ||
| import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; | ||
| import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; | ||
| import MimeTabs from "@theme/MimeTabs"; | ||
| import ParamsItem from "@theme/ParamsItem"; | ||
| import ResponseSamples from "@theme/ResponseSamples"; | ||
| import SchemaItem from "@theme/SchemaItem"; | ||
| import SchemaTabs from "@theme/SchemaTabs"; | ||
| import Markdown from "@theme/Markdown"; | ||
| import OperationTabs from "@theme/OperationTabs"; | ||
| import TabItem from "@theme/TabItem"; | ||
|
|
||
| <h1 className={"openapi__heading"}>Assign a user to a group</h1> | ||
|
|
||
| <MethodEndpoint | ||
| method={"post"} | ||
| path={"/groups/{groupKey}/users/{userKey}"} | ||
| ></MethodEndpoint> | ||
|
|
||
| Assigns a user to a group. | ||
|
|
||
| ## Request | ||
|
|
||
| <details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"groupKey","in":"path","required":true,"description":"The group key.","schema":{"type":"integer","format":"int64"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"userKey","in":"path","required":true,"description":"The user key.","schema":{"type":"integer","format":"int64"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div> | ||
|
|
||
| The user was assigned successfully to the group. | ||
|
|
||
| </div><div></div></TabItem><TabItem label={"400"} value={"400"}><div> | ||
|
|
||
| The user could not be assigned. | ||
| More details are provided in the response body. | ||
|
|
||
| </div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/problem+json"} value={"application/problem+json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the problem type.","default":"about:blank"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A summary of the problem type."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An explanation of the problem in more detail."}}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the origin of the problem."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 0,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div> | ||
|
|
||
| Forbidden. The request is not allowed. | ||
|
|
||
| </div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/problem+json"} value={"application/problem+json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the problem type.","default":"about:blank"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A summary of the problem type."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An explanation of the problem in more detail."}}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the origin of the problem."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 0,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div> | ||
|
|
||
| The group or user with the given key was not found. | ||
|
|
||
| </div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/problem+json"} value={"application/problem+json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the problem type.","default":"about:blank"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A summary of the problem type."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An explanation of the problem in more detail."}}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the origin of the problem."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 0,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"409"} value={"409"}><div> | ||
|
|
||
| The user with the given key is already assigned to the group. | ||
|
|
||
| </div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/problem+json"} value={"application/problem+json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the problem type.","default":"about:blank"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A summary of the problem type."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An explanation of the problem in more detail."}}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the origin of the problem."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 0,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div> | ||
|
|
||
| An internal error occurred while processing the request. | ||
|
|
||
| </div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/problem+json"} value={"application/problem+json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the problem type.","default":"about:blank"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A summary of the problem type."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 400` and `<= 600`"} schema={{"type":"integer","format":"int32","description":"The HTTP status code for this problem.","minimum":400,"maximum":600}}></SchemaItem><SchemaItem collapsible={false} name={"detail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An explanation of the problem in more detail."}}></SchemaItem><SchemaItem collapsible={false} name={"instance"} required={false} schemaName={"uri"} qualifierMessage={undefined} schema={{"type":"string","format":"uri","description":"A URI identifying the origin of the problem."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"type\": \"about:blank\",\n \"title\": \"string\",\n \"status\": 0,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |
Oops, something went wrong.