> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/agentix-api/cortex-platform-iam/models.md). # Models ## The Metadata object ```json {"openapi":"3.0.2","info":{"title":"Cortex Platform IAM APIs","version":"Cortex AgentiX"},"components":{"schemas":{"Metadata":{"type":"object","description":"Metadata for the response"}}}} ``` ## The RoleCreateRequest object ```json {"openapi":"3.0.2","info":{"title":"Cortex Platform IAM APIs","version":"Cortex AgentiX"},"components":{"schemas":{"RoleCreateRequest":{"type":"object","additionalProperties":false,"properties":{"request_data":{"type":"object","properties":{"component_permissions":{"type":"array","description":"List of component permissions for the role. Possible values can be found by using the permission configs API and referring to the `rbac_permissions` field.","minItems":1,"items":{"type":"string"}},"dataset_permissions":{"type":"array","nullable":true,"description":"Optional list of dataset permissions. This must be a list of JSONs. The layout for this JSON can be found under the 'DatasetPermission' schema . Note: possible dataset values can be found by using the permission configs API and referring to the `datasetGroups` field.","items":{"type":"object"}},"pretty_name":{"type":"string","description":"Name of the role","minLength":1},"description":{"type":"string","nullable":true,"description":"Optional description of the role"}},"required":["component_permissions","pretty_name"]}},"required":["request_data"]}}}} ``` ## The UserGroupCreateRequest object ```json {"openapi":"3.0.2","info":{"title":"Cortex Platform IAM APIs","version":"Cortex AgentiX"},"components":{"schemas":{"UserGroupCreateRequest":{"type":"object","additionalProperties":false,"properties":{"request_data":{"type":"object","properties":{"group_name":{"type":"string","description":"Name of the user group","minLength":1},"role_id":{"type":"string","nullable":true,"description":"Unique identifier of the role"},"description":{"type":"string","nullable":true,"description":"Optional description of the user group"},"users":{"type":"array","nullable":true,"description":"List of users for the user group","items":{"type":"string"}},"nested_group_ids":{"type":"array","nullable":true,"description":"List of nested groups","items":{"type":"string"}},"idp_groups":{"type":"array","nullable":true,"description":"List of idp groups","items":{"type":"string"}}},"required":["group_name"]}},"required":["request_data"]}}}} ``` ## The UserGroupEditRequest object ```json {"openapi":"3.0.2","info":{"title":"Cortex Platform IAM APIs","version":"Cortex AgentiX"},"components":{"schemas":{"UserGroupEditRequest":{"type":"object","additionalProperties":false,"properties":{"request_data":{"type":"object","properties":{"group_name":{"type":"string","nullable":true,"description":"Name of the user group"},"role_id":{"type":"string","nullable":true,"description":"Unique identifier of the role"},"description":{"type":"string","nullable":true,"description":"Optional description of the user group"},"users":{"type":"array","nullable":true,"description":"List of users for the user group","items":{"type":"string"}},"nested_group_ids":{"type":"array","nullable":true,"description":"List of nested groups","items":{"type":"string"}},"idp_groups":{"type":"array","nullable":true,"description":"List of idp groups","items":{"type":"string"}}}}},"required":["request_data"]}}}} ``` ## The EntityType object ```json {"openapi":"3.0.2","info":{"title":"Cortex Platform IAM APIs","version":"Cortex AgentiX"},"components":{"schemas":{"EntityType":{"type":"string","enum":["user","user-group","api-key"],"description":"The type of entity - Possible values: user (Signifies that the entity is a user), usergroup (Signifies that the entity is a custom or AD user group), apikey (Signifies that the entity is an API key)"}}}} ``` ## The ScopeEditRequest object ```json {"openapi":"3.0.2","info":{"title":"Cortex Platform IAM APIs","version":"Cortex AgentiX"},"components":{"schemas":{"ScopeEditRequest":{"type":"object","additionalProperties":false,"properties":{"request_data":{"type":"object","properties":{"tags_scope":{"type":"object","nullable":true,"description":"Definition of tags scope configuration"},"tagless_scope":{"type":"object","nullable":true,"description":"Definition of tagless scope configuration"}}}},"required":["request_data"]}}}} ``` ## The UserEditRequest object ```json {"openapi":"3.0.2","info":{"title":"Cortex Platform IAM APIs","version":"Cortex AgentiX"},"components":{"schemas":{"UserEditRequest":{"type":"object","additionalProperties":false,"properties":{"request_data":{"type":"object","properties":{"user_first_name":{"type":"string","nullable":true,"description":"User's first name"},"user_last_name":{"type":"string","nullable":true,"description":"User's last name"},"role_id":{"type":"string","nullable":true,"description":"User's assigned role. Note: this refers to the 'role_id' attribute from the Role APIs (the unique role identifier)"},"phone_number":{"type":"string","nullable":true,"description":"User's phone number"},"status":{"type":"string","nullable":true,"description":"User's status"},"is_hidden":{"type":"boolean","nullable":true,"description":"User's hidden status"},"user_groups":{"type":"array","nullable":true,"description":"User's assigned groups","items":{"type":"string"}}}}},"required":["request_data"]}}}} ``` ## The ApiKeyEditRequest object ```json {"openapi":"3.0.2","info":{"title":"Cortex Platform IAM APIs","version":"Cortex AgentiX"},"components":{"schemas":{"ApiKeyEditRequest":{"type":"object","additionalProperties":false,"properties":{"request_data":{"type":"object","properties":{"roles":{"type":"array","description":"API Key's assigned roles. Note: this refers to the 'role_id' attributes from the Role APIs (the unique role identifiers)","items":{"type":"string"}},"security_level":{"type":"string","description":"API Key's security level"},"comment":{"type":"string","nullable":true,"description":"API Key's comment"}},"required":["roles","security_level"]}},"required":["request_data"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://cortex-docs.paloaltonetworks.com/agentix-api/cortex-platform-iam/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.