Get Identity Policy - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"api","title":"Get Identity Policy","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/830d1f62208c73e8aeba17d0e26773e8902a279e/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.17.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.uae.security.cisco.com/firewall","description":"UAE"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.dev.secure.cisco/api/rest","description":"Devf9"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"},{"url":"https://manage.secure.cisco/api/rest","description":"ProdF9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the identity policy associated with the specified UUID.**","operationId":"getIdentityPolicy","parameters":[{"description":"UUID of the identity policy.","in":"path","name":"objectId","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 3 : GET /fmc_config/v1/domain/domainUUID/policy/identitypolicies/objectId ( Get IdentityPolicy by id )":{"value":{"activeAuthPage":"CUSTOM","activeSessionSharing":true,"authCert":{"id":"627aeb37-6c5b-4484-a124-e05572a9aedc","name":"heliosCert","type":"PKI_InternalCert"},"categories":{"links":{"self":"/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/identitypolicies/11b35dac-4522-11f0-b0ab-81022e6a6647/categories"},"refType":"list","type":"IdentityPolicyCategory"},"description":"","htmlActiveAuthPage":"\u003chtml\u003e\u003chead\u003e\u003ctitle\u003eRedirecting to Identity Policy\u003c/title\u003e\u003c/head\u003e\u003cbody\u003e\u003ch1\u003eRedirecting to Identity Policy\u003c/h1\u003e\u003c/body\u003e\u003c/html\u003e","id":"11b35dac-4522-11f0-b0ab-81022e6a6647","mappingFilter":{"id":"21b39d26-3b57-4ee3-9f78-da2313df7817","name":"filterForIdentityPolicy","type":"Network"},"maxLoginAttempts":3,"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"isCaptiveRuleEnabled":false,"readOnly":{"state":false}},"name":"IdentityPolicy1","redirectHost":{"id":"7acd23e2-a828-4d05-bdc1-fd8dca7e8434","name":"hostForRedirect","type":"FQDN"},"redirectPort":885,"rules":{"links":{"self":"/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/identitypolicies/11b35dac-4522-11f0-b0ab-81022e6a6647/rules"},"refType":"list","type":"IdentityRule"},"type":"IdentityPolicy"}}},"schema":{"description":"Contains information about the Identity Policy used by the Firepower Threat Defense device.","properties":{"activeAuthPage":{"type":"string"},"activeSessionSharing":{"type":"boolean"},"authCert":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/ReferenceObject"},"categories":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"refType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IdentityPolicyReferenceLinks"},"description":{"type":"string"},"htmlActiveAuthPage":{"type":"string"},"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"mappingFilter":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/ReferenceObject"},"maxLoginAttempts":{"format":"int32","type":"integer"},"metadata":{"properties":{"domain":{"description":"The details about the domain.","properties":{"description":{"type":"string"},"hostLimit":{"description":"Maximum number of hosts in the domain.","format":"int32","type":"integer"},"id":{"description":"Unique UUID of this domain.","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"$ref":"#/components/schemas/DomainMetadata","type":"object"},"name":{"description":"Name of the domain or keywords used to filter from domain names.","type":"string"},"parentUUID":{"description":"UUID of the parent domain.","type":"string"},"tenantUUID":{"description":"UUID of the tenant used for domain mapping.","type":"string"},"type":{"description":"Domain type definition.","type":"string"},"uuid":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/Domain"},"isCaptiveRuleEnabled":{"type":"boolean"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","description":"This object defines details about the user.","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/IdentityPolicyMetadata","description":"Object representing metadata properties of response object."},"name":{"description":"User chosen resource name.","type":"string"},"redirectHost":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/ReferenceObject"},"redirectPort":{"format":"int32","type":"integer"},"rules":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"refType":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IdentityPolicyReferenceLinks"},"type":{"type":"string"},"version":{"description":"Version of the Object.","type":"string"}},"type":"object","$$ref":"#/components/schemas/IdentityPolicy"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Policy"],"__originalOperationId":"getIdentityPolicy","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/identitypolicies/{objectId}"}}