{"items":[{"type":"link","label":"Access Management API","link":"/openapi/rbacapi","routeSlug":"/openapi/rbacapi","content":{"contentType":"overview","meta":{"name":"Access Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"RbacApi.json","url":"/_bundle/openapi/RbacApi.json?download"},{"kind":"download","label":"RbacApi.yaml","url":"/_bundle/openapi/RbacApi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Access Management API (v3)","showPageActions":true}],"sectionId":"/"}]}]}},{"type":"group","label":"User Groups","link":"/openapi/rbacapi/user-groups","routeSlug":"/openapi/rbacapi/user-groups","items":[{"label":"List user groups for company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/user-groups/listusergroupsforcompany","routeSlug":"/openapi/rbacapi/user-groups/listusergroupsforcompany","metadata":{"seo":{"title":"List user groups for company","description":"This endpoint provides list of user groups of a company, with filtering, sorting, and pagination support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGroupsForCompany","name":"List user groups for company","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user groups for company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint provides list of user groups of a company, with filtering, sorting, and pagination support."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier of the company.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserGroupsRequest"}},"schemaId":"components/schemas/ListUserGroupsRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/user-groups/list","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListUserGroupsRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/companies/{companyId}/user-groups/list","href":"user-groups/listusergroupsforcompany","openApiOperationId":"listUserGroupsForCompany","summary":"List user groups for company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ListUserGroupsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserGroupsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserGroupsResponse"}},"schemaId":"components/schemas/ListUserGroupsResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1list/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListUserGroupsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserGroupsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups/list"},{"label":"Create user group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/user-groups/createusergroup","routeSlug":"/openapi/rbacapi/user-groups/createusergroup","metadata":{"seo":{"title":"Create user group","description":"This endpoint is used to create user groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUserGroup","name":"Create user group","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create user group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is used to create user groups."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Company ID of the user group.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserGroupUpdateRequest"}},"schemaId":"components/schemas/UserGroupUpdateRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/user-groups","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserGroupUpdateRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/companies/{companyId}/user-groups","href":"user-groups/createusergroup","openApiOperationId":"createUserGroup","summary":"Create user group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/UserGroupUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserGroupUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityId"}},"schemaId":"components/schemas/EntityId"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityId"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups"},{"label":"Read user group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/user-groups/getusergroup","routeSlug":"/openapi/rbacapi/user-groups/getusergroup","metadata":{"seo":{"title":"Read user group","description":"This endpoint returns user group information for given group ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserGroup","name":"Read user group","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read user group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint returns user group information for given group ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Company ID of the user group.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653"},{"name":"groupId","in":"path","schemaId":"schema_0","description":"Identifier for the user group.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/companies/{companyId}/user-groups/{groupId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653","schemaId":"schema_0"},{"name":"groupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/user-groups/{groupId}","href":"user-groups/getusergroup","openApiOperationId":"getUserGroup","summary":"Read user group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleUserGroup"}},"schemaId":"components/schemas/RoleUserGroup"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoleUserGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleUserGroup"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups/{groupId}"},{"label":"Delete user group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/user-groups/deleteusergroup","routeSlug":"/openapi/rbacapi/user-groups/deleteusergroup","metadata":{"seo":{"title":"Delete user group","description":"This endpoint deletes a user group by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserGroup","name":"Delete user group","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint deletes a user group by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Company ID of the user group.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653"},{"name":"groupId","in":"path","schemaId":"schema_0","description":"Identifier for the user group.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/companies/{companyId}/user-groups/{groupId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653","schemaId":"schema_0"},{"name":"groupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/companies/{companyId}/user-groups/{groupId}","href":"user-groups/deleteusergroup","openApiOperationId":"deleteUserGroup","summary":"Delete user group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups/{groupId}"},{"label":"Update user group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/user-groups/updateusergroup","routeSlug":"/openapi/rbacapi/user-groups/updateusergroup","metadata":{"seo":{"title":"Update user group","description":"Update user group"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUserGroup","name":"Update user group","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Company ID of the user group.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653"},{"name":"groupId","in":"path","schemaId":"schema_0","description":"Identifier for the user group.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserGroupUpdateRequest"}},"schemaId":"components/schemas/UserGroupUpdateRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/companies/{companyId}/user-groups/{groupId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653","schemaId":"schema_0"},{"name":"groupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserGroupUpdateRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/user-groups/{groupId}","href":"user-groups/updateusergroup","openApiOperationId":"updateUserGroup","summary":"Update user group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/UserGroupUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserGroupUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups/{groupId}"},{"label":"List user group members","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/user-groups/listusergroupmembers","routeSlug":"/openapi/rbacapi/user-groups/listusergroupmembers","metadata":{"seo":{"title":"List user group members","description":"This endpoint provides a list of members in a user group with filtering, sorting, and pagination support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGroupMembers","name":"List user group members","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user group members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint provides a list of members in a user group with filtering, sorting, and pagination support."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Company ID of the user group.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653"},{"name":"groupId","in":"path","schemaId":"schema_0","description":"Identifier for the user group.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1members/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserGroupMembersRequest"}},"schemaId":"components/schemas/ListUserGroupMembersRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1members/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/user-groups/{groupId}/members","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653","schemaId":"schema_0"},{"name":"groupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListUserGroupMembersRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/user-groups/{groupId}/members","href":"user-groups/listusergroupmembers","openApiOperationId":"listUserGroupMembers","summary":"List user group members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ListUserGroupMembersRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserGroupMembersRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserGroupMembersResponse"}},"schemaId":"components/schemas/ListUserGroupMembersResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1members/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListUserGroupMembersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserGroupMembersResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups/{groupId}/members"},{"label":"Update user group members","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/user-groups/updateusergroupmembers","routeSlug":"/openapi/rbacapi/user-groups/updateusergroupmembers","metadata":{"seo":{"title":"Update user group members","description":"This endpoint updates the members of a user group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUserGroupMembers","name":"Update user group members","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1members/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user group members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint updates the members of a user group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Company ID of the user group.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653"},{"name":"groupId","in":"path","schemaId":"schema_0","description":"Identifier for the user group.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1members/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupMembersRequest"}},"schemaId":"components/schemas/UpdateUserGroupMembersRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1members/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/companies/{companyId}/user-groups/{groupId}/members","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653","schemaId":"schema_0"},{"name":"groupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupMembersRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/user-groups/{groupId}/members","href":"user-groups/updateusergroupmembers","openApiOperationId":"updateUserGroupMembers","summary":"Update user group members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateUserGroupMembersRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateUserGroupMembersRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Successfully"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1members/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups/{groupId}/members"},{"label":"List user groups for user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/user-groups/listusergroupsforuser","routeSlug":"/openapi/rbacapi/user-groups/listusergroupsforuser","metadata":{"seo":{"title":"List user groups for user","description":"This endpoint provides list of user groups of a user, with filtering, sorting, and pagination support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGroupsForUser","name":"List user groups for user","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1user-groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user groups for user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint provides list of user groups of a user, with filtering, sorting, and pagination support."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Identifier of the user.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1users~1{userId}~1user-groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserGroupsRequest"}},"schemaId":"components/schemas/ListUserGroupsRequest","pointer":"/paths/~1v3~1users~1{userId}~1user-groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/{userId}/user-groups","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListUserGroupsRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/users/{userId}/user-groups","href":"user-groups/listusergroupsforuser","openApiOperationId":"listUserGroupsForUser","summary":"List user groups for user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ListUserGroupsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserGroupsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserGroupsResponse"}},"schemaId":"components/schemas/ListUserGroupsResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1users~1{userId}~1user-groups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListUserGroupsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserGroupsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/users/{userId}/user-groups"}],"content":{"contentType":"group","meta":{"name":"User Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User Groups","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage use groups."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/companies/{companyId}/user-groups/list","summary":"List user groups for company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-groups/listusergroupsforcompany","deprecated":false},{"title":"/v3/companies/{companyId}/user-groups","summary":"Create user group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-groups/createusergroup","deprecated":false},{"title":"/v3/companies/{companyId}/user-groups/{groupId}","summary":"Read user group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user-groups/getusergroup","deprecated":false},{"title":"/v3/companies/{companyId}/user-groups/{groupId}","summary":"Delete user group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user-groups/deleteusergroup","deprecated":false},{"title":"/v3/companies/{companyId}/user-groups/{groupId}","summary":"Update user group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user-groups/updateusergroup","deprecated":false},{"title":"/v3/companies/{companyId}/user-groups/{groupId}/members","summary":"List user group members","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-groups/listusergroupmembers","deprecated":false},{"title":"/v3/companies/{companyId}/user-groups/{groupId}/members","summary":"Update user group members","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/user-groups/updateusergroupmembers","deprecated":false},{"title":"/v3/users/{userId}/user-groups","summary":"List user groups for user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user-groups/listusergroupsforuser","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/openapi/rbacapi/roles","routeSlug":"/openapi/rbacapi/roles","items":[{"label":"List all permissions on the platform","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/listpermissions","routeSlug":"/openapi/rbacapi/roles/listpermissions","metadata":{"seo":{"title":"List all permissions on the platform","description":"This endpoint returns all available permissions on the platform for display purposes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPermissions","name":"List all permissions on the platform","isWebhook":false,"pointer":"/paths/~1v3~1permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all permissions on the platform","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint returns all available permissions on the platform for display purposes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/permissions","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/permissions","href":"roles/listpermissions","openApiOperationId":"listPermissions","summary":"List all permissions on the platform"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPermissionsResponse"}},"schemaId":"components/schemas/ListPermissionsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1permissions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPermissionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPermissionsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/permissions"},{"label":"List permissions for a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/listcompanypermissions","routeSlug":"/openapi/rbacapi/roles/listcompanypermissions","metadata":{"seo":{"title":"List permissions for a company","description":"This endpoint returns all available permissions for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanyPermissions","name":"List permissions for a company","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List permissions for a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint returns all available permissions for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier of the company.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1permissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/companies/{companyId}/permissions","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/companies/{companyId}/permissions","href":"roles/listcompanypermissions","openApiOperationId":"listCompanyPermissions","summary":"List permissions for a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPermissionsResponse"}},"schemaId":"components/schemas/ListPermissionsResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1permissions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPermissionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPermissionsResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/permissions"},{"label":"List user roles for company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/listrolesv3","routeSlug":"/openapi/rbacapi/roles/listrolesv3","metadata":{"seo":{"title":"List user roles for company","description":"This endpoint provides list of available user roles for a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRolesV3","name":"List user roles for company","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user roles for company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint provides list of available user roles for a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier of the company.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListRolesRequest"}},"schemaId":"components/schemas/ListRolesRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/roles","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListRolesRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/companies/{companyId}/roles","href":"roles/listrolesv3","openApiOperationId":"listRolesV3","summary":"List user roles for company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ListRolesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListRolesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRolesResponse"}},"schemaId":"components/schemas/ListRolesResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRolesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRolesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/roles"},{"label":"Create role","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/createrolev3","routeSlug":"/openapi/rbacapi/roles/createrolev3","metadata":{"seo":{"title":"Create role","description":"This endpoint is used to create user roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRoleV3","name":"Create role","isWebhook":false,"pointer":"/paths/~1v3~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is used to create user roles."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRoleRequest"}},"schemaId":"components/schemas/CreateRoleRequest","pointer":"/paths/~1v3~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/roles","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRoleRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/roles","href":"roles/createrolev3","openApiOperationId":"createRoleV3","summary":"Create role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/CreateRoleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRoleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityId"}},"schemaId":"components/schemas/EntityId"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityId"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/roles"},{"label":"Get role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/getrolev3","routeSlug":"/openapi/rbacapi/roles/getrolev3","metadata":{"seo":{"title":"Get role","description":"This endpoint returns role details for given role ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRoleV3","name":"Get role","isWebhook":false,"pointer":"/paths/~1v3~1roles~1{roleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint returns role details for given role ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"schema_0","description":"Identifier for role.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1roles~1{roleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/roles/{roleId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v3/roles/{roleId}","href":"roles/getrolev3","openApiOperationId":"getRoleV3","summary":"Get role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleV3"}},"schemaId":"components/schemas/RoleV3"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1roles~1{roleId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoleV3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleV3"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/roles/{roleId}"},{"label":"Delete role","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/deleterolev3","routeSlug":"/openapi/rbacapi/roles/deleterolev3","metadata":{"seo":{"title":"Delete role","description":"This endpoint deletes a role by role ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRoleV3","name":"Delete role","isWebhook":false,"pointer":"/paths/~1v3~1roles~1{roleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint deletes a role by role ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"schema_0","description":"Identifier for role.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1roles~1{roleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/roles/{roleId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/roles/{roleId}","href":"roles/deleterolev3","openApiOperationId":"deleteRoleV3","summary":"Delete role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1roles~1{roleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/roles/{roleId}"},{"label":"Update role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/updaterolev3","routeSlug":"/openapi/rbacapi/roles/updaterolev3","metadata":{"seo":{"title":"Update role","description":"Update role"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRoleV3","name":"Update role","isWebhook":false,"pointer":"/paths/~1v3~1roles~1{roleId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"roleId","in":"path","schemaId":"schema_0","description":"Identifier for role.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1roles~1{roleId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRoleRequest"}},"schemaId":"components/schemas/UpdateRoleRequest","pointer":"/paths/~1v3~1roles~1{roleId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v3/roles/{roleId}","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"roleId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateRoleRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/roles/{roleId}","href":"roles/updaterolev3","openApiOperationId":"updateRoleV3","summary":"Update role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateRoleRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRoleRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1roles~1{roleId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/roles/{roleId}"},{"label":"Get applicable scopes for selected roles.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/getapplicablescopes","routeSlug":"/openapi/rbacapi/roles/getapplicablescopes","metadata":{"seo":{"title":"Get applicable scopes for selected roles.","description":"Returns the applicable scope predicate types and their permitted values for the selected roles within a company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicableScopes","name":"Get applicable scopes for selected roles.","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1roles~1applicable-scopes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get applicable scopes for selected roles.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the applicable scope predicate types and their permitted values for the selected roles within a company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Identifier of the company.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1roles~1applicable-scopes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetApplicableScopesRequest"}},"schemaId":"components/schemas/GetApplicableScopesRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1roles~1applicable-scopes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/roles/applicable-scopes","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetApplicableScopesRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/roles/applicable-scopes","href":"roles/getapplicablescopes","openApiOperationId":"getApplicableScopes","summary":"Get applicable scopes for selected roles."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/GetApplicableScopesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetApplicableScopesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Applicable scopes for the selected roles.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApplicableScopesResponse"}},"schemaId":"components/schemas/GetApplicableScopesResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1roles~1applicable-scopes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetApplicableScopesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApplicableScopesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/roles/applicable-scopes"},{"label":"List user group roles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/listusergrouprolesv3","routeSlug":"/openapi/rbacapi/roles/listusergrouprolesv3","metadata":{"seo":{"title":"List user group roles","description":"This endpoint provides list of roles assigned to the usergroup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGroupRolesV3","name":"List user group roles","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user group roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint provides list of roles assigned to the usergroup."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Company ID of the user group.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653"},{"name":"groupId","in":"path","schemaId":"schema_0","description":"Identifier for the user group.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserGroupRolesRequest"}},"schemaId":"components/schemas/ListUserGroupRolesRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/companies/{companyId}/user-groups/{groupId}/roles","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653","schemaId":"schema_0"},{"name":"groupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListUserGroupRolesRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/companies/{companyId}/user-groups/{groupId}/roles","href":"roles/listusergrouprolesv3","openApiOperationId":"listUserGroupRolesV3","summary":"List user group roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ListUserGroupRolesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserGroupRolesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserGroupRolesResponse"}},"schemaId":"components/schemas/ListUserGroupRolesResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListUserGroupRolesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserGroupRolesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups/{groupId}/roles"},{"label":"Update user group roles","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/updateusergrouprolesv3","routeSlug":"/openapi/rbacapi/roles/updateusergrouprolesv3","metadata":{"seo":{"title":"Update user group roles","description":"This endpoint updates roles assigned to a usergroup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUserGroupRolesV3","name":"Update user group roles","isWebhook":false,"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1roles/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user group roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint updates roles assigned to a usergroup."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"companyId","in":"path","schemaId":"schema_0","description":"Company ID of the user group.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653"},{"name":"groupId","in":"path","schemaId":"schema_0","description":"Identifier for the user group.","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1roles/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRolesRequest"}},"schemaId":"components/schemas/UpdateRolesRequest","pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1roles/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/companies/{companyId}/user-groups/{groupId}/roles","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"companyId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093653","schemaId":"schema_0"},{"name":"groupId","in":"path","required":true,"example":"4974a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateRolesRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/companies/{companyId}/user-groups/{groupId}/roles","href":"roles/updateusergrouprolesv3","openApiOperationId":"updateUserGroupRolesV3","summary":"Update user group roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateRolesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRolesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1companies~1{companyId}~1user-groups~1{groupId}~1roles/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/companies/{companyId}/user-groups/{groupId}/roles"},{"label":"List user roles","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/listuserrolesv3","routeSlug":"/openapi/rbacapi/roles/listuserrolesv3","metadata":{"seo":{"title":"List user roles","description":"This endpoint provides list of roles assigned to the user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserRolesV3","name":"List user roles","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1roles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint provides list of roles assigned to the user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Identifier of the user.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1users~1{userId}~1roles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserRolesRequest"}},"schemaId":"components/schemas/ListUserRolesRequest","pointer":"/paths/~1v3~1users~1{userId}~1roles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/{userId}/roles","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ListUserRolesRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v3/users/{userId}/roles","href":"roles/listuserrolesv3","openApiOperationId":"listUserRolesV3","summary":"List user roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/ListUserRolesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ListUserRolesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserRolesResponse"}},"schemaId":"components/schemas/ListUserRolesResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1users~1{userId}~1roles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListUserRolesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListUserRolesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/users/{userId}/roles"},{"label":"Update user roles","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/updateuserrolesv3","routeSlug":"/openapi/rbacapi/roles/updateuserrolesv3","metadata":{"seo":{"title":"Update user roles","description":"This endpoint updates roles assigned to a user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUserRolesV3","name":"Update user roles","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1roles/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint updates roles assigned to a user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Identifier of the user.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1users~1{userId}~1roles/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRolesRequest"}},"schemaId":"components/schemas/UpdateRolesRequest","pointer":"/paths/~1v3~1users~1{userId}~1roles/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v3/users/{userId}/roles","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateRolesRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/users/{userId}/roles","href":"roles/updateuserrolesv3","openApiOperationId":"updateUserRolesV3","summary":"Update user roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/UpdateRolesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateRolesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1users~1{userId}~1roles/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/users/{userId}/roles"},{"label":"Get user permissions on specific entity.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/getentitypermissions","routeSlug":"/openapi/rbacapi/roles/getentitypermissions","metadata":{"seo":{"title":"Get user permissions on specific entity.","description":"Returns user's permissions with actions on a specified entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntityPermissions","name":"Get user permissions on specific entity.","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1entity-permissions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user permissions on specific entity.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns user's permissions with actions on a specified entity."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_1","description":"User ID","required":true}],"pointer":"/paths/~1v3~1users~1{userId}~1entity-permissions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetEntityPermissionsRequest"}},"schemaId":"components/schemas/GetEntityPermissionsRequest","pointer":"/paths/~1v3~1users~1{userId}~1entity-permissions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/users/{userId}/entity-permissions","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"f49d00fe-1eda-4304-ba79-a980f565281d","schemaId":"schema_1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetEntityPermissionsRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v3/users/{userId}/entity-permissions","href":"roles/getentitypermissions","openApiOperationId":"getEntityPermissions","summary":"Get user permissions on specific entity."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"schemaId":"components/schemas/GetEntityPermissionsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetEntityPermissionsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of permissions user has on the entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEntityPermissionsResponse"}},"schemaId":"components/schemas/GetEntityPermissionsResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1users~1{userId}~1entity-permissions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEntityPermissionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEntityPermissionsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/users/{userId}/entity-permissions"},{"label":"Get RBAC info for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/rbacapi/roles/getrbacinfo","routeSlug":"/openapi/rbacapi/roles/getrbacinfo","metadata":{"seo":{"title":"Get RBAC info for a user","description":"Returns RBAC information for a user indicating what permissions the user has."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRbacInfo","name":"Get RBAC info for a user","isWebhook":false,"pointer":"/paths/~1v3~1users~1{userId}~1rbac-info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get RBAC info for a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns RBAC information for a user indicating what permissions the user has."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_0","description":"Identifier of the user.","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947"}],"pointer":"/paths/~1v3~1users~1{userId}~1rbac-info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/users/{userId}/rbac-info","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"example":"1234a66b-7493-4f41-908c-58ba81093947","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v3/users/{userId}/rbac-info","href":"roles/getrbacinfo","openApiOperationId":"getRbacInfo","summary":"Get RBAC info for a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","description":"Spotnana mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"RBAC info for the user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRbacInfoResponse"}},"schemaId":"components/schemas/GetRbacInfoResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"The specified resource was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1users~1{userId}~1rbac-info/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetRbacInfoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetRbacInfoResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v3/users/{userId}/rbac-info"}],"content":{"contentType":"group","meta":{"name":"Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage roles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/permissions","summary":"List all permissions on the platform","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/listpermissions","deprecated":false},{"title":"/v3/companies/{companyId}/permissions","summary":"List permissions for a company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/listcompanypermissions","deprecated":false},{"title":"/v3/companies/{companyId}/roles","summary":"List user roles for company","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/listrolesv3","deprecated":false},{"title":"/v3/roles","summary":"Create role","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/createrolev3","deprecated":false},{"title":"/v3/roles/{roleId}","summary":"Get role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/getrolev3","deprecated":false},{"title":"/v3/roles/{roleId}","summary":"Delete role","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/roles/deleterolev3","deprecated":false},{"title":"/v3/roles/{roleId}","summary":"Update role","prefix":{"name":"put","color":"put"},"badges":[],"link":"/roles/updaterolev3","deprecated":false},{"title":"/v3/companies/{companyId}/roles/applicable-scopes","summary":"Get applicable scopes for selected roles.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/getapplicablescopes","deprecated":false},{"title":"/v3/companies/{companyId}/user-groups/{groupId}/roles","summary":"List user group roles","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/listusergrouprolesv3","deprecated":false},{"title":"/v3/companies/{companyId}/user-groups/{groupId}/roles","summary":"Update user group roles","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/roles/updateusergrouprolesv3","deprecated":false},{"title":"/v3/users/{userId}/roles","summary":"List user roles","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/listuserrolesv3","deprecated":false},{"title":"/v3/users/{userId}/roles","summary":"Update user roles","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/roles/updateuserrolesv3","deprecated":false},{"title":"/v3/users/{userId}/entity-permissions","summary":"Get user permissions on specific entity.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/roles/getentitypermissions","deprecated":false},{"title":"/v3/users/{userId}/rbac-info","summary":"Get RBAC info for a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/getrbacinfo","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ApplicableScope":{"id":"components/schemas/ApplicableScope","kind":"json-schema","title":"ApplicableScope","data":{"type":"object","title":"ApplicableScope","description":"An applicable scope indicating the predicate type and its permitted values.","required":["predicateType"],"properties":{"predicateType":{"$ref":"#/components/schemas/ScopePredicateType"},"allowedValues":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed values for this predicate type. Present for predicate types that have enumerable values (e.g. STEALTH_TYPE)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ScopePredicateValue"}}}}},"components/schemas/AudiencePredicate":{"id":"components/schemas/AudiencePredicate","kind":"json-schema","title":"AudiencePredicate","data":{"type":"object","title":"AudiencePredicate","description":"Predicate granting access to a subset of platform.","discriminator":{"propertyName":"type","mapping":{"PLATFORM":"#/components/schemas/PlatformPredicate","BOOKING_TMC":"#/components/schemas/BookingTmcPredicate","CONTRACTING_TMC":"#/components/schemas/ContractingTmcPredicate","COMPANY":"#/components/schemas/CompanyPredicate","LEGAL_ENTITY":"#/components/schemas/LegalEntityPredicate","PROFILE":"#/components/schemas/ProfilePredicate","STEALTH_TYPE":"#/components/schemas/StealthTypePredicate","TRIP_TEMPLATE":"#/components/schemas/TripTemplatePredicate","PERSONA":"#/components/schemas/PersonaScopePredicate"}},"oneOf":[{"$ref":"#/components/schemas/PlatformPredicate"},{"$ref":"#/components/schemas/BookingTmcPredicate"},{"$ref":"#/components/schemas/ContractingTmcPredicate"},{"$ref":"#/components/schemas/CompanyPredicate"},{"$ref":"#/components/schemas/LegalEntityPredicate"},{"$ref":"#/components/schemas/ProfilePredicate"},{"$ref":"#/components/schemas/StealthTypePredicate"},{"$ref":"#/components/schemas/TripTemplatePredicate"},{"$ref":"#/components/schemas/PersonaScopePredicate"}]}},"components/schemas/BookingTmcPredicate":{"id":"components/schemas/BookingTmcPredicate","kind":"json-schema","title":"BookingTmcPredicate","data":{"title":"BookingTmcPredicate","description":"Compare the booking tmc of the traveler with the values.","required":["type","comparator","values"],"properties":{"type":{"type":"string","default":"BOOKING_TMC"},"comparator":{"$ref":"#/components/schemas/ScopeEntitiesComparator"},"values":{"type":"array","description":"List of UUID values to compare.","minItems":1,"items":{"type":"string","format":"uuid"},"example":["1234a66b-7493-4f41-908c-58ba81093947"]},"valuesWithLabel":{"type":"array","description":"Values with labels","minItems":1,"items":{"$ref":"#/components/schemas/Reference"}}}}},"components/schemas/CompanyPredicate":{"id":"components/schemas/CompanyPredicate","kind":"json-schema","title":"CompanyPredicate","data":{"title":"CompanyPredicate","description":"Compare the traveler company with the values.","required":["type","comparator","values"],"properties":{"type":{"type":"string","default":"COMPANY"},"comparator":{"$ref":"#/components/schemas/ScopeEntitiesComparator"},"values":{"type":"array","description":"List of UUID values to compare.","minItems":1,"items":{"type":"string","format":"uuid"},"example":["1234a66b-7493-4f41-908c-58ba81093947"]},"valuesWithLabel":{"type":"array","description":"Values with labels","minItems":1,"items":{"$ref":"#/components/schemas/Reference"}}}}},"components/schemas/ContractingTmcPredicate":{"id":"components/schemas/ContractingTmcPredicate","kind":"json-schema","title":"ContractingTmcPredicate","data":{"title":"ContractingTmcPredicate","description":"Compare the contracting TMC of the traveler with the values.","required":["type","comparator","values"],"properties":{"type":{"type":"string","default":"CONTRACTING_TMC"},"comparator":{"$ref":"#/components/schemas/ScopeEntitiesComparator"},"values":{"type":"array","description":"List of UUID values to compare.","minItems":1,"items":{"type":"string","format":"uuid"},"example":["1234a66b-7493-4f41-908c-58ba81093947"]},"valuesWithLabel":{"type":"array","description":"Values with labels","minItems":1,"items":{"$ref":"#/components/schemas/Reference"}}}}},"components/schemas/CreateRoleRequest":{"id":"components/schemas/CreateRoleRequest","kind":"json-schema","title":"CreateRoleRequest","data":{"type":"object","title":"CreateRoleRequest","description":"Role create request.","required":["name","description","isPlatformRole","permissions"],"properties":{"name":{"type":"string","description":"Name of the role.","example":"User Admin"},"description":{"type":"string","description":"A short description of the role mentioning what can it do.","example":"Manage users for the company."},"isPlatformRole":{"type":"boolean","default":false,"description":"Whether role is platform provided.","example":false},"companyId":{"type":"string","format":"uuid","description":"Company ID which owns the role.","example":"1aeef911-44cf-49bb-83c7-e06b0d4e7ac2"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionWithActions"},"description":"Permissions granted to the role."}}}},"components/schemas/DateTimeOffset":{"id":"components/schemas/DateTimeOffset","kind":"json-schema","title":"DateTimeOffset","data":{"title":"DateTimeOffset","description":"ISO8601 UTC Date Time","type":"object","required":["iso8601"],"properties":{"iso8601":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-4]):([0-5][0-9])(:([0-5][0-9]))?(Z|([+-](0[0-9]|1[0-4]):([0-5][0-9])))$","example":"2017-07-21T17:32Z"}}}},"components/schemas/EntityId":{"id":"components/schemas/EntityId","kind":"json-schema","title":"EntityId","data":{"type":"object","description":"Identifier of an object","required":["id"],"properties":{"id":{"type":"string","format":"uuid","example":"b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"}}}},"components/schemas/EntityPermission":{"id":"components/schemas/EntityPermission","kind":"json-schema","title":"EntityPermission","data":{"type":"object","title":"EntityPermission","description":"Permission the user holds on an entity.","required":["permission","actions"],"properties":{"permission":{"$ref":"#/components/schemas/PermissionName","example":"USER_MANAGEMENT"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionAction"},"description":"Actions allowed on the permission like read/write/delete.","example":["READ","WRITE"]},"scopeAttributes":{"$ref":"#/components/schemas/ScopeAttributes"}}}},"components/schemas/ErrorParameter":{"id":"components/schemas/ErrorParameter","kind":"json-schema","title":"ErrorParameter","data":{"type":"object","title":"ErrorParameter","description":"Error parameter","properties":{"name":{"type":"string","description":"Parameter name"},"value":{"type":"string","description":"Parameter value"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"debugIdentifier":{"type":"string","description":"Link to debug the error internally."},"errorMessages":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code to identify the specific errors."},"message":{"type":"string","description":"Message containing details of error."},"errorParameters":{"type":"array","description":"Error message parameters.","items":{"$ref":"#/components/schemas/ErrorParameter"}},"errorDetail":{"type":"string","description":"More details about the error."}}}}}}},"components/schemas/GetApplicableScopesRequest":{"id":"components/schemas/GetApplicableScopesRequest","kind":"json-schema","title":"GetApplicableScopesRequest","data":{"type":"object","title":"GetApplicableScopesRequest","description":"Request to get applicable scopes for selected roles.","properties":{"roleIds":{"type":"array","description":"List of selected role identifiers.","items":{"type":"string","format":"uuid"},"example":["1aeef911-44cf-49bb-83c7-e06b0d4e7ac2"]},"selectedAudience":{"$ref":"#/components/schemas/ScopeAudience"}}}},"components/schemas/GetApplicableScopesResponse":{"id":"components/schemas/GetApplicableScopesResponse","kind":"json-schema","title":"GetApplicableScopesResponse","data":{"type":"object","title":"GetApplicableScopesResponse","description":"Response containing applicable scopes for the selected roles.","required":["applicableScopes"],"properties":{"applicableScopes":{"type":"array","description":"List of applicable scopes with their predicate types and permitted values.","items":{"$ref":"#/components/schemas/ApplicableScope"}}}}},"components/schemas/GetEntityPermissionsRequest":{"id":"components/schemas/GetEntityPermissionsRequest","kind":"json-schema","title":"GetEntityPermissionsRequest","data":{"type":"object","title":"GetEntityPermissionsRequest","description":"Request to get permissions on an entity.","required":["entityId","entityType"],"properties":{"entityId":{"type":"string","description":"Unique identifier of the entity.","example":"4974a66b-7493-4f41-908c-58ba81093947"},"entityType":{"$ref":"#/components/schemas/ScopeEntityType"}}}},"components/schemas/GetEntityPermissionsResponse":{"id":"components/schemas/GetEntityPermissionsResponse","kind":"json-schema","title":"GetEntityPermissionsResponse","data":{"type":"object","title":"GetEntityPermissionsResponse","description":"Response containing permissions on an entity.","required":["permissions"],"properties":{"permissions":{"type":"array","description":"List of permissions user has on the entity.","items":{"$ref":"#/components/schemas/EntityPermission"}}}}},"components/schemas/GetRbacInfoResponse":{"id":"components/schemas/GetRbacInfoResponse","kind":"json-schema","title":"GetRbacInfoResponse","data":{"type":"object","title":"GetRbacInfoResponse","description":"Response containing RBAC info for a user.","required":["hasOthersTripAccess","permissions"],"properties":{"hasOthersTripAccess":{"type":"boolean","description":"Flag indicating whether user has access to trips of other travelers.","example":true},"permissions":{"type":"array","description":"List of permissions with their associated actions for the user.","items":{"$ref":"#/components/schemas/PermissionWithActions"}}}}},"components/schemas/LegalEntityPredicate":{"id":"components/schemas/LegalEntityPredicate","kind":"json-schema","title":"LegalEntityPredicate","data":{"title":"LegalEntityPredicate","description":"Compare the traveler legal entity with the values.","required":["type","comparator","values"],"properties":{"type":{"type":"string","default":"LEGAL_ENTITY"},"comparator":{"$ref":"#/components/schemas/ScopeEntitiesComparator"},"values":{"type":"array","description":"List of UUID values to compare.","minItems":1,"items":{"type":"string","format":"uuid"},"example":["1234a66b-7493-4f41-908c-58ba81093947"]},"valuesWithLabel":{"type":"array","description":"Values with labels","minItems":1,"items":{"$ref":"#/components/schemas/Reference"}}}}},"components/schemas/ListPermissionsResponse":{"id":"components/schemas/ListPermissionsResponse","kind":"json-schema","title":"ListPermissionsResponse","data":{"type":"object","title":"ListPermissionsResponse","description":"Response containing list of available permissions.","required":["permissions"],"properties":{"permissions":{"type":"array","description":"List of available permissions.","items":{"$ref":"#/components/schemas/Permission"}}}}},"components/schemas/ListRoleFilter":{"id":"components/schemas/ListRoleFilter","kind":"json-schema","title":"ListRoleFilter","data":{"type":"object","title":"ListRoleFilter","description":"Filter parameters for roles.","properties":{"roleIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of role ids."},"roleProvidedBy":{"type":"array","items":{"$ref":"#/components/schemas/RoleProvidedBy"},"description":"Filter by role providers."}}}},"components/schemas/ListRolesRequest":{"id":"components/schemas/ListRolesRequest","kind":"json-schema","title":"ListRolesRequest","data":{"type":"object","title":"ListRolesRequest","description":"List roles request.","required":["pagination"],"properties":{"searchText":{"type":"string","description":"Query text to search roles. The match would be case-insensitive.","example":"Admin"},"pagination":{"description":"Pagination information for request.","$ref":"#/components/schemas/OffsetBasedPaginationRequestParams"},"sortParams":{"description":"Sorting related parameters.","$ref":"#/components/schemas/RoleSortParams"},"filters":{"type":"array","description":"List of filters. Roles matching with any filter would be returned.","items":{"$ref":"#/components/schemas/ListRoleFilter"}}}}},"components/schemas/ListRolesResponse":{"id":"components/schemas/ListRolesResponse","kind":"json-schema","title":"ListRolesResponse","data":{"type":"object","title":"ListRolesResponse","description":"List roles response.","required":["roles","pagination"],"properties":{"roles":{"type":"array","description":"Roles matching with the request.","items":{"$ref":"#/components/schemas/RoleV3"}},"pagination":{"$ref":"#/components/schemas/OffsetBasedPaginationResponseParams","description":"Pagination information for response."}}}},"components/schemas/ListUserGroupFilter":{"id":"components/schemas/ListUserGroupFilter","kind":"json-schema","title":"ListUserGroupFilter","data":{"type":"object","title":"ListUserGroupFilter","description":"Filter parameters for user groups.","properties":{"userGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of user group ids."},"permissions":{"type":"array","description":"Filter by permissions. User groups having any role with any of these permissions would\nbe returned.\n","items":{"$ref":"#/components/schemas/UserGroupPermissionFilter"}}}}},"components/schemas/ListUserGroupMemberFilter":{"id":"components/schemas/ListUserGroupMemberFilter","kind":"json-schema","title":"ListUserGroupMemberFilter","data":{"type":"object","title":"ListUserGroupMemberFilter","description":"Filter parameters for user group members.","properties":{"addedAfter":{"description":"Filter by users added after this date (inclusive).","$ref":"#/components/schemas/DateTimeOffset"},"addedBefore":{"description":"Filter by users added before this date (exclusive).","$ref":"#/components/schemas/DateTimeOffset"},"userIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Filter by specific user IDs.","example":["1234a66b-7493-4f41-908c-58ba81093947"]}}}},"components/schemas/ListUserGroupMembersRequest":{"id":"components/schemas/ListUserGroupMembersRequest","kind":"json-schema","title":"ListUserGroupMembersRequest","data":{"type":"object","title":"ListUserGroupMembersRequest","description":"List user group members request.","required":["pagination"],"properties":{"pagination":{"description":"Pagination information for request.","$ref":"#/components/schemas/OffsetBasedPaginationRequestParams"},"sortParams":{"description":"Sorting related parameters.","$ref":"#/components/schemas/UserGroupMemberSortParams"},"filters":{"type":"array","description":"List of filters. Members matching with any filter would be returned.","items":{"$ref":"#/components/schemas/ListUserGroupMemberFilter"}}}}},"components/schemas/ListUserGroupMembersResponse":{"id":"components/schemas/ListUserGroupMembersResponse","kind":"json-schema","title":"ListUserGroupMembersResponse","data":{"type":"object","title":"ListUserGroupMembersResponse","description":"List user group members response.","required":["members","pagination"],"properties":{"members":{"type":"array","description":"List of user group members with their details.","items":{"$ref":"#/components/schemas/UserGroupMember"}},"pagination":{"$ref":"#/components/schemas/OffsetBasedPaginationResponseParams","description":"Pagination information for response."}}}},"components/schemas/ListUserGroupRolesRequest":{"id":"components/schemas/ListUserGroupRolesRequest","kind":"json-schema","title":"ListUserGroupRolesRequest","data":{"type":"object","title":"ListUserGroupRolesRequest","description":"List user group roles request.","required":["pagination"],"properties":{"searchText":{"type":"string","description":"Query text to search roles. The match would be case-insensitive.","example":"Admin"},"pagination":{"description":"Pagination information for request.","$ref":"#/components/schemas/OffsetBasedPaginationRequestParams"},"sortParams":{"description":"Sorting related parameters.","$ref":"#/components/schemas/RoleSortParams"},"filters":{"type":"array","description":"List of filters. Roles matching with any filter would be returned.","items":{"$ref":"#/components/schemas/ListRoleFilter"}}}}},"components/schemas/ListUserGroupRolesResponse":{"id":"components/schemas/ListUserGroupRolesResponse","kind":"json-schema","title":"ListUserGroupRolesResponse","data":{"type":"object","title":"ListUserGroupRolesResponse","description":"List user group roles response.","required":["roles","pagination"],"properties":{"roles":{"type":"array","description":"Roles assigned to the group matching with the request.","items":{"$ref":"#/components/schemas/RoleWithScope"}},"pagination":{"$ref":"#/components/schemas/OffsetBasedPaginationResponseParams","description":"Pagination information for response."}}}},"components/schemas/ListUserGroupsRequest":{"id":"components/schemas/ListUserGroupsRequest","kind":"json-schema","title":"ListUserGroupsRequest","data":{"type":"object","title":"ListUserGroupsRequest","description":"List user groups request.","required":["pagination"],"properties":{"searchText":{"type":"string","description":"Query text to search user groups. The match would be case-insensitive.","example":"Company Admins"},"pagination":{"description":"Pagination information for request.","$ref":"#/components/schemas/OffsetBasedPaginationRequestParams"},"sortParams":{"description":"Sorting related parameters.","$ref":"#/components/schemas/UserGroupSortParams"},"filters":{"type":"array","description":"List of filters. User groups matching with any filter would be returned.","items":{"$ref":"#/components/schemas/ListUserGroupFilter"}}}}},"components/schemas/ListUserGroupsResponse":{"id":"components/schemas/ListUserGroupsResponse","kind":"json-schema","title":"ListUserGroupsResponse","data":{"type":"object","title":"ListUserGroupsResponse","description":"List user groups response.","required":["userGroups","pagination"],"properties":{"userGroups":{"type":"array","description":"User groups matching with the request.","items":{"$ref":"#/components/schemas/RoleUserGroup"}},"pagination":{"$ref":"#/components/schemas/OffsetBasedPaginationResponseParams","description":"Pagination information for response."}}}},"components/schemas/ListUserRolesRequest":{"id":"components/schemas/ListUserRolesRequest","kind":"json-schema","title":"ListUserRolesRequest","data":{"type":"object","title":"ListUserRolesRequest","description":"List user roles request.","required":["pagination"],"properties":{"searchText":{"type":"string","description":"Query text to search roles. The match would be case-insensitive.","example":"Admin"},"pagination":{"description":"Pagination information for request.","$ref":"#/components/schemas/OffsetBasedPaginationRequestParams"},"sortParams":{"description":"Sorting related parameters.","$ref":"#/components/schemas/RoleSortParams"},"filters":{"type":"array","description":"List of filters. Roles matching with any filter would be returned.","items":{"$ref":"#/components/schemas/ListRoleFilter"}}}}},"components/schemas/ListUserRolesResponse":{"id":"components/schemas/ListUserRolesResponse","kind":"json-schema","title":"ListUserRolesResponse","data":{"type":"object","title":"ListUserRolesResponse","description":"List user roles response.","required":["roles","pagination"],"properties":{"roles":{"type":"array","description":"Roles assigned to the user matching with the request.","items":{"$ref":"#/components/schemas/RoleWithScope"}},"pagination":{"$ref":"#/components/schemas/OffsetBasedPaginationResponseParams","description":"Pagination information for response."}}}},"components/schemas/NonUuidReference":{"id":"components/schemas/NonUuidReference","kind":"json-schema","title":"NonUuidReference","data":{"type":"object","title":"NonUuidReference","description":"Reference object containing id and name of the entity.","required":["id"],"properties":{"id":{"type":"string","example":"1234567"},"name":{"type":"string","example":"Name"}}}},"components/schemas/OffsetBasedPaginationRequestParams":{"id":"components/schemas/OffsetBasedPaginationRequestParams","kind":"json-schema","title":"OffsetBasedPaginationRequestParams","data":{"type":"object","title":"OffsetBasedPaginationRequestParams","description":"Pagination parameters for requests.","properties":{"offset":{"type":"integer","format":"int32","description":"The starting index in the list from which results are returned. The value must be greater than or equal to 0.","default":0,"minimum":0},"limit":{"type":"integer","format":"int32","description":"Maximum number of results to be fetched.","minimum":1,"default":100}}}},"components/schemas/OffsetBasedPaginationResponseParams":{"id":"components/schemas/OffsetBasedPaginationResponseParams","kind":"json-schema","title":"PaginationResponseParams","data":{"type":"object","title":"PaginationResponseParams","description":"Pagination parameters for response.","required":["totalNumResults"],"properties":{"totalNumResults":{"type":"integer","format":"int32","description":"Total number of results."}}}},"components/schemas/Permission":{"id":"components/schemas/Permission","kind":"json-schema","title":"Permission","data":{"type":"object","title":"Permission","description":"Permission definition.","required":["name","description"],"properties":{"name":{"$ref":"#/components/schemas/PermissionName"},"description":{"type":"string","description":"Description of the permission.","example":"Manage company settings and configurations."},"parentName":{"$ref":"#/components/schemas/PermissionName"}}}},"components/schemas/PermissionAction":{"id":"components/schemas/PermissionAction","kind":"json-schema","title":"PermissionAction","data":{"type":"string","title":"PermissionAction","description":"Actions which can be performed for a given permission.","enum":["ALL","CREATE","READ","WRITE","DELETE","UNMASK","PURGE"],"example":"READ","x-enumDescriptions":{"ALL":"Every action on the permission, including actions added in future.","CREATE":"Create entities governed by the permission.","READ":"View entities governed by the permission.","WRITE":"Modify entities governed by the permission.","DELETE":"Delete entities governed by the permission.","UNMASK":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View PII unmasked. Read modifier implied by ALL; valid only on USER_PROFILE together with READ."},"children":[]}]}]}],"PURGE":"Permanently purge entities governed by the permission."}}},"components/schemas/PermissionName":{"id":"components/schemas/PermissionName","kind":"json-schema","title":"PermissionName","data":{"type":"string","title":"PermissionName","description":"Permission","enum":["PLATFORM_MANAGEMENT","TMC_MANAGEMENT","COMPANY_MANAGEMENT","USER_MANAGEMENT","USER_PROFILE","EVENT_MANAGEMENT","REPORT_MANAGEMENT","ACCESS_MANAGEMENT","TRIP_MANAGEMENT","AGENT","DEVELOPER_PLATFORM_MANAGEMENT","THIRD_PARTY_NOTIFICATION_MANAGEMENT","AGENT_CONTACT_CENTER_MANAGEMENT","AGENT_CONTACT_CENTER_SUPPORT_MANAGEMENT","AGENT_CONTACT_CENTER_TEAM_MANAGEMENT","AGENT_CONTACT_CENTER_ANALYTICS_MANAGEMENT","AGENT_CONTACT_CENTER_SETTINGS_MANAGEMENT"],"example":"COMPANY_MANAGEMENT"}},"components/schemas/PermissionWithActions":{"id":"components/schemas/PermissionWithActions","kind":"json-schema","title":"PermissionWithActions","data":{"type":"object","title":"PermissionWithActions","description":"Permission with actions","required":["permission","actions"],"properties":{"permission":{"$ref":"#/components/schemas/PermissionName","example":"USER_MANAGEMENT"},"actions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionAction"},"description":"Actions allowed on the permission like read/write/delete.","example":["READ","WRITE"]}}}},"components/schemas/PersonaScopePredicate":{"id":"components/schemas/PersonaScopePredicate","kind":"json-schema","title":"PersonaScopePredicate","data":{"type":"object","title":"PersonaScopePredicate","description":"Compare the traveler's persona with the values. This is an attribute predicate that narrows an entity predicate in the same audience and cannot be used on its own.","required":["type","comparator","values"],"properties":{"type":{"type":"string","default":"PERSONA"},"comparator":{"$ref":"#/components/schemas/ScopeEntitiesComparator"},"values":{"type":"array","description":"List of personas to compare.","minItems":1,"items":{"$ref":"#/components/schemas/PersonaScopeValue"}}}}},"components/schemas/PersonaScopeValue":{"id":"components/schemas/PersonaScopeValue","kind":"json-schema","title":"PersonaScopeValue","data":{"type":"string","title":"PersonaScopeValue","description":"Personas that a role scope can be narrowed to.","enum":["GUEST"],"example":"GUEST"}},"components/schemas/PlatformGroupType":{"id":"components/schemas/PlatformGroupType","kind":"json-schema","title":"PlatformGroupType","data":{"type":"string","title":"PlatformGroupType","description":"Type of a platform created user group.","enum":["COMPANY_ADMIN","COMPANY_TRAVEL_ARRANGER","TMC_ADMIN","TMC_AGENT","GLOBAL_ADMIN","GLOBAL_AGENT"],"example":"COMPANY_ADMIN"}},"components/schemas/PlatformPredicate":{"id":"components/schemas/PlatformPredicate","kind":"json-schema","title":"PlatformPredicate","data":{"type":"object","title":"PlatformPredicate","description":"Predicate granting access to the entire platform.","required":["type","value"],"properties":{"type":{"type":"string","default":"PLATFORM"},"value":{"type":"boolean","default":false,"example":false}}}},"components/schemas/ProfilePredicate":{"id":"components/schemas/ProfilePredicate","kind":"json-schema","title":"ProfilePredicate","data":{"title":"ProfilePredicate","description":"Compare the traveler's user id with the values.","required":["type","comparator","values"],"properties":{"type":{"type":"string","default":"PROFILE"},"comparator":{"$ref":"#/components/schemas/ScopeEntitiesComparator"},"values":{"type":"array","description":"List of UUID values to compare.","minItems":1,"items":{"type":"string","format":"uuid"},"example":["1234a66b-7493-4f41-908c-58ba81093947"]},"valuesWithLabel":{"type":"array","description":"Values with labels","minItems":1,"items":{"$ref":"#/components/schemas/Reference"}}}}},"components/schemas/Reference":{"id":"components/schemas/Reference","kind":"json-schema","title":"Reference object containing uuid and name of the entity.","data":{"type":"object","title":"Reference object containing uuid and name of the entity.","description":"Reference of an entity","required":["id"],"properties":{"id":{"type":"string","format":"uuid","example":"b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"},"name":{"type":"string","example":"Name"}}}},"components/schemas/RoleProvidedBy":{"id":"components/schemas/RoleProvidedBy","kind":"json-schema","title":"RoleProvidedBy","data":{"type":"string","title":"RoleProvidedBy","description":"The role provider ie platform or company.","enum":["PLATFORM","COMPANY"]}},"components/schemas/RoleRefWithScope":{"id":"components/schemas/RoleRefWithScope","kind":"json-schema","title":"RoleRefWithScope","data":{"type":"object","title":"RoleRefWithScope","description":"Role reference with scope information.","required":["roleId","scope"],"properties":{"roleId":{"type":"string","format":"uuid","description":"Role identifier.","example":"1aeef911-44cf-49bb-83c7-e06b0d4e7ac2"},"scope":{"$ref":"#/components/schemas/Scope"}}}},"components/schemas/RoleSortField":{"id":"components/schemas/RoleSortField","kind":"json-schema","title":"RoleSortField","data":{"type":"string","title":"RoleSortField","description":"The field name to sort roles.","enum":["NAME"],"default":"NAME"}},"components/schemas/RoleSortParams":{"id":"components/schemas/RoleSortParams","kind":"json-schema","title":"RoleSortParams","data":{"type":"object","title":"RoleSortParams","description":"Sorting related parameters to return sorted list of roles.","required":["sortBy","sortOrder"],"properties":{"sortBy":{"$ref":"#/components/schemas/RoleSortField"},"sortOrder":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/RoleUserGroup":{"id":"components/schemas/RoleUserGroup","kind":"json-schema","title":"RoleUserGroup","data":{"type":"object","title":"RoleUserGroup","description":"User group","required":["id","name","description","companyId","createdAt","updatedAt","createdBy","updatedBy"],"properties":{"id":{"type":"string","format":"uuid","description":"User group identifier.","example":"4974a66b-7493-4f41-908c-58ba81093947"},"name":{"type":"string","description":"Name of the user group.","example":"Company Admins"},"description":{"type":"string","description":"A description of the user group.","example":"Group for managing the company settings."},"companyId":{"type":"string","format":"uuid","description":"Company ID of the user group.","example":"1234a66b-7493-4f41-908c-58ba81093653"},"createdAt":{"description":"Date and time when the user group was created.","$ref":"#/components/schemas/DateTimeOffset"},"updatedAt":{"description":"Date and time when the user group was last updated.","$ref":"#/components/schemas/DateTimeOffset"},"createdBy":{"description":"User who created the user group.","$ref":"#/components/schemas/Reference"},"updatedBy":{"description":"User who last updated the user group.","$ref":"#/components/schemas/Reference"},"isUnmodifiable":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the group is not modifiable. This would be set true only for platform created groups."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only group name, description and assigned roles & scopes can not be modified but members"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can still be updated."},"children":[]}]}]}],"type":"boolean","default":false},"platformGroupType":{"description":"Type of the platform created group. Set only for platform created groups and absent for\ncustom groups.\n","$ref":"#/components/schemas/PlatformGroupType"}}}},"components/schemas/RoleV3":{"id":"components/schemas/RoleV3","kind":"json-schema","title":"RoleV3","data":{"type":"object","title":"RoleV3","description":"Role information.","required":["id","name","description","isPlatformRole","permissions","createdAt","updatedAt","createdBy","updatedBy"],"properties":{"id":{"type":"string","format":"uuid","description":"Role identifier."},"name":{"type":"string","description":"Name of the role.","example":"User Admin"},"description":{"type":"string","description":"A short description of the role mentioning what can it do.","example":"Manage users for the company."},"isPlatformRole":{"type":"boolean","default":false,"description":"Whether role is platform provided.","example":false},"companyId":{"type":"string","format":"uuid","description":"Company ID which owns the role.","example":"1aeef911-44cf-49bb-83c7-e06b0d4e7ac2"},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionWithActions"},"description":"Permissions granted to the role."},"createdAt":{"description":"Date and time when the role was created.","$ref":"#/components/schemas/DateTimeOffset"},"updatedAt":{"description":"Date and time when the role was last updated.","$ref":"#/components/schemas/DateTimeOffset"},"createdBy":{"description":"User who created the role.","$ref":"#/components/schemas/Reference"},"updatedBy":{"description":"User who last updated the role.","$ref":"#/components/schemas/Reference"}}}},"components/schemas/RoleWithScope":{"id":"components/schemas/RoleWithScope","kind":"json-schema","title":"RoleScope","data":{"type":"object","title":"RoleScope","description":"Role along with the scope they are applicable for.","required":["role","scope"],"properties":{"role":{"$ref":"#/components/schemas/RoleV3"},"scope":{"$ref":"#/components/schemas/Scope"}}}},"components/schemas/Scope":{"id":"components/schemas/Scope","kind":"json-schema","title":"Scope","data":{"type":"object","title":"Scope","description":"The set of resources or the resource group that the role applies to.","required":["audiences"],"properties":{"audiences":{"type":"array","items":{"$ref":"#/components/schemas/ScopeAudience"},"minItems":1}}}},"components/schemas/ScopeAttributes":{"id":"components/schemas/ScopeAttributes","kind":"json-schema","title":"ScopeAttributes","data":{"type":"object","title":"ScopeAttributes","description":"Scope attribute values the permission is limited to. Applicable only to entity types above profile (e.g. company, legal entity, TMC, event); never set for profile, trip or PNR. Set when the granting scope is narrowed by personas or stealth types the entity itself does not carry, e.g. a GUEST-only scope checked on a company. Absent when the permission is unrestricted on the entity, which, as for every scope, covers non-stealth users only.","properties":{"personas":{"type":"array","description":"Personas of the users the permission applies to. Empty means any persona.","items":{"$ref":"#/components/schemas/PersonaScopeValue"},"example":["GUEST"]},"stealthTypes":{"type":"array","description":"Stealth types of the users the permission applies to. Empty means non-stealth users only.","items":{"$ref":"#/components/schemas/StealthType"},"example":["STEALTH_TYPE_1"]}}}},"components/schemas/ScopeAudience":{"id":"components/schemas/ScopeAudience","kind":"json-schema","title":"ScopeAudience","data":{"type":"object","title":"ScopeAudience","description":"The audience that the scope audience applies to.","required":["predicates"],"properties":{"predicates":{"type":"array","items":{"$ref":"#/components/schemas/AudiencePredicate"},"minItems":1}}}},"components/schemas/ScopeEntitiesComparator":{"id":"components/schemas/ScopeEntitiesComparator","kind":"json-schema","title":"ScopeEntitiesComparator","data":{"type":"string","description":"The comparator to compare scope entity values.","enum":["IN"]}},"components/schemas/ScopeEntityType":{"id":"components/schemas/ScopeEntityType","kind":"json-schema","title":"ScopeEntityType","data":{"title":"ScopeEntityType","description":"Entity type enum.","type":"string","enum":["PROFILE","LEGAL_ENTITY","COMPANY","PNR","TRIP","EVENT","TRIP_TEMPLATE","PLATFORM"],"example":"LEGAL_ENTITY"}},"components/schemas/ScopePredicateType":{"id":"components/schemas/ScopePredicateType","kind":"json-schema","title":"ScopePredicateType","data":{"type":"string","title":"ScopePredicateType","description":"Type of scope predicate.","enum":["PLATFORM","BOOKING_TMC","CONTRACTING_TMC","COMPANY","TRIP_TEMPLATE","STEALTH_TYPE","PERSONA"],"example":"CONTRACTING_TMC"}},"components/schemas/ScopePredicateValue":{"id":"components/schemas/ScopePredicateValue","kind":"json-schema","title":"ScopePredicateValue","data":{"type":"object","title":"ScopePredicateValue","description":"A permitted value for a scope predicate type.","required":["value"],"properties":{"value":{"type":"string","description":"The predicate value identifier.","example":"STEALTH_TYPE_1"},"label":{"type":"string","description":"Readable label for the value.","example":"VIP Travel"}}}},"components/schemas/SortOrder":{"id":"components/schemas/SortOrder","kind":"json-schema","title":"SortOrder","data":{"type":"string","description":"Sorting order.","enum":["DESC","ASC"],"example":"DESC","default":"ASC"}},"components/schemas/StealthType":{"id":"components/schemas/StealthType","kind":"json-schema","title":"StealthType","data":{"type":"string","description":"Stealth type.","enum":["STEALTH_TYPE_1","STEALTH_TYPE_2","STEALTH_TYPE_3"],"example":"STEALTH_TYPE_1","x-ignoreBreakingChanges":["StealthType->STEALTH_TYPE_4","StealthType->STEALTH_TYPE_5","StealthType->STEALTH_TYPE_6"]}},"components/schemas/StealthTypePredicate":{"id":"components/schemas/StealthTypePredicate","kind":"json-schema","title":"StealthTypePredicate","data":{"type":"object","title":"StealthTypePredicate","description":"Compare the traveler's stealth type with the values.","required":["type","comparator","values"],"properties":{"type":{"type":"string","default":"STEALTH_TYPE"},"comparator":{"$ref":"#/components/schemas/ScopeEntitiesComparator"},"values":{"type":"array","description":"List of stealth types to compare.","minItems":1,"items":{"$ref":"#/components/schemas/StealthType"}}}}},"components/schemas/TripTemplatePredicate":{"id":"components/schemas/TripTemplatePredicate","kind":"json-schema","title":"TripTemplatePredicate","data":{"type":"object","title":"TripTemplatePredicate","description":"Compare the trip's template id with the values.","required":["type","comparator","values"],"properties":{"type":{"type":"string","default":"TRIP_TEMPLATE"},"comparator":{"$ref":"#/components/schemas/ScopeEntitiesComparator"},"values":{"type":"array","description":"List of trip template ids to compare.","minItems":1,"items":{"type":"string"}},"valuesWithLabel":{"type":"array","description":"Values with labels","minItems":1,"items":{"$ref":"#/components/schemas/NonUuidReference"}}}}},"components/schemas/UpdateRoleRequest":{"id":"components/schemas/UpdateRoleRequest","kind":"json-schema","title":"UpdateRoleRequest","data":{"type":"object","title":"UpdateRoleRequest","description":"Role update request.","required":["name","description","permissions"],"properties":{"name":{"type":"string","description":"Name of the role.","example":"User Admin"},"description":{"type":"string","description":"A short description of the role mentioning what can it do.","example":"Manage users for the company."},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/PermissionWithActions"},"description":"Permissions granted to the role."}}}},"components/schemas/UpdateRolesRequest":{"id":"components/schemas/UpdateRolesRequest","kind":"json-schema","title":"UpdateRolesRequest","data":{"type":"object","title":"UpdateRolesRequest","description":"Update roles request for a principal.","properties":{"rolesToAdd":{"type":"array","description":"List of roles to be assigned to a principal.","items":{"$ref":"#/components/schemas/RoleRefWithScope"},"default":[]},"rolesToDelete":{"type":"array","description":"List of roles to be removed for a principal.","items":{"type":"string","format":"uuid"},"default":[]}}}},"components/schemas/UpdateUserGroupMembersRequest":{"id":"components/schemas/UpdateUserGroupMembersRequest","kind":"json-schema","title":"UpdateUserGroupMembersRequest","data":{"type":"object","title":"UpdateUserGroupMembersRequest","description":"Update user group members request.","required":["userIdsToAdd","userIdsToRemove"],"properties":{"userIdsToAdd":{"type":"array","description":"List of user ids to be added to the user group.","items":{"type":"string","format":"uuid"},"example":["1234a66b-7493-4f41-908c-58ba81093947"]},"userIdsToRemove":{"type":"array","description":"List of user ids to be removed from the user group.","items":{"type":"string","format":"uuid"},"example":["4974a66b-7493-4f41-908c-58ba81093947"]}}}},"components/schemas/UserGroupMember":{"id":"components/schemas/UserGroupMember","kind":"json-schema","title":"UserGroupMember","data":{"type":"object","title":"UserGroupMember","description":"User group member information.","required":["userId","addedAt"],"properties":{"userId":{"type":"string","format":"uuid","description":"The ID of the user who is a member of the group.","example":"1234a66b-7493-4f41-908c-58ba81093947"},"addedAt":{"description":"The date and time when the user was added to the group.","$ref":"#/components/schemas/DateTimeOffset"}}}},"components/schemas/UserGroupMemberSortField":{"id":"components/schemas/UserGroupMemberSortField","kind":"json-schema","title":"UserGroupMemberSortField","data":{"type":"string","title":"UserGroupMemberSortField","description":"The field name to sort user group members.","enum":["ADDED_AT"],"default":"ADDED_AT"}},"components/schemas/UserGroupMemberSortParams":{"id":"components/schemas/UserGroupMemberSortParams","kind":"json-schema","title":"UserGroupMemberSortParams","data":{"type":"object","title":"UserGroupMemberSortParams","description":"Sorting related parameters to return sorted list of user group members.","required":["sortBy","sortOrder"],"properties":{"sortBy":{"$ref":"#/components/schemas/UserGroupMemberSortField"},"sortOrder":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/UserGroupPermissionFilter":{"id":"components/schemas/UserGroupPermissionFilter","kind":"json-schema","title":"UserGroupPermissionFilter","data":{"type":"object","title":"UserGroupPermissionFilter","description":"Permission filter for user groups.","required":["permission"],"properties":{"permission":{"description":"Permission which the user group's roles should have.","$ref":"#/components/schemas/PermissionName"},"actions":{"type":"array","description":"Actions which the roles must have on the permission. If empty, any action matches.","items":{"$ref":"#/components/schemas/PermissionAction"}}}}},"components/schemas/UserGroupSortField":{"id":"components/schemas/UserGroupSortField","kind":"json-schema","title":"UserGroupSortField","data":{"type":"string","title":"UserGroupSortField","description":"The field name to sort user groups.","enum":["NAME","CREATED_AT"],"default":"NAME"}},"components/schemas/UserGroupSortParams":{"id":"components/schemas/UserGroupSortParams","kind":"json-schema","title":"UserGroupSortParams","data":{"type":"object","title":"UserGroupSortParams","description":"Sorting related parameters to return sorted list of user groups.","required":["sortBy","sortOrder"],"properties":{"sortBy":{"$ref":"#/components/schemas/UserGroupSortField"},"sortOrder":{"$ref":"#/components/schemas/SortOrder"}}}},"components/schemas/UserGroupUpdateRequest":{"id":"components/schemas/UserGroupUpdateRequest","kind":"json-schema","title":"UserGroupUpdateRequest","data":{"type":"object","title":"UserGroupUpdateRequest","description":"User group update request","required":["name","description"],"properties":{"name":{"type":"string","description":"Name of the user group.","example":"Company Admins"},"description":{"type":"string","description":"A description of the user group.","example":"Group for managing the company settings."}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"f49d00fe-1eda-4304-ba79-a980f565281d"},"id":"schema_1"}},"exampleStore":{},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer"}},"specVersion":"3.1.0","servers":[{"url":"https://api-ext-sboxmeta.partners.spotnana.com","description":"Sandbox URL"},{"url":"/_mock/openapi/rbacapi","isMockServer":true,"description":"Spotnana mock server"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"mockServer":{"url":"/_mock/openapi/rbacapi","position":"last","description":"Spotnana mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/RbacApi.json?download"},{"url":"/_bundle/openapi/RbacApi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Access Management API"}},"baseSlug":"/openapi/rbacapi","routesMapping":{}}