Jump to

• Request
• Response

Build policy cache from the current policies

post

/iam/admin/ssa/api/v1/policycacheadmin/policycache

Build policy cache with the current policies in the OAM database. While the policy cache is being built, the runtime servers will still be using the existing policy cache.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Policy cache request

Root Schema : CacheUpdateRequest

Type: object

Show Source

• forceUpdate: boolean
  Whether to forceupdate the policy cache even when current version is the latest version built. By default this is false and the policy cache will not be updated unless it is not the latest.

{
    "type":"object",
    "properties":{
        "forceUpdate":{
            "type":"boolean",
            "description":"Whether to forceupdate the policy cache even when current version is the latest version built. By default this is false and the policy cache will not be updated unless it is not the latest."
        }
    },
    "required":[
        "forceUpdate"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Policy Cache info fetched successfully.

Body ()

Root Schema : CacheUpdateResponse

Type: object

Show Source

• checkSum: string
  The hash value of the policy cache. Can be used for checking two versions of the policy cache.
• message(optional): string
  The return message for this operation. If the operation failed, the error message has the required details on what went wrong while performing the operation.
• updatedBy: string
  Reference of user that updated the policycache. In case its forceupdated, the REST username is used.
• updatedOrCreated(optional): boolean
  Whether the existing cache row is updated due to this REST API call or created.
• updateTime: string
  The date time when the cache was last finised creation and written into the table.
• version: string
  version number of this policy cache. Used for updation logic for runtime and admin servers.

{
    "type":"object",
    "properties":{
        "updatedBy":{
            "type":"string",
            "description":"Reference of user that updated the policycache. In case its forceupdated, the REST username is used."
        },
        "updateTime":{
            "type":"string",
            "description":"The date time when the cache was last finised creation and written into the table."
        },
        "updatedOrCreated":{
            "type":"boolean",
            "description":"Whether the existing cache row is updated due to this REST API call or created."
        },
        "checkSum":{
            "type":"string",
            "description":"The hash value of the policy cache. Can be used for checking two versions of the policy cache."
        },
        "version":{
            "type":"string",
            "description":"version number of this policy cache. Used for updation logic for runtime and admin servers."
        },
        "message":{
            "type":"string",
            "description":"The return message for this operation. If the operation failed, the error message has the required details on what went wrong while performing the operation."
        }
    },
    "required":[
        "updatedBy",
        "updateTime",
        "checkSum",
        "version"
    ]
}

401 Response

Not authorized.

500 Response

Internal Server Error

Back to Top