Access Policies

Quick Navigation

• GET AccessPolicies
• POST AccessPolicies/Test

GET AccessPolicies

Purpose

Returns a list of Password Safe access policies.

Required Permissions

Password Safe Role Management (Read).

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        AccessPolicyID:int,
        Name:string,
        Description:string,
        Schedules :
        [
            {
                ScheduleID : int,
                RequireReason : bool,
                RequireTicketSystem : bool,
                TicketSystemID : short?,
                AccessTypes :
                [
                    {
                        AccessType : string,
                        IsSession : bool,
                        RecordSession : bool,
                        MinApprovers : int,
                        MaxConcurrent : int
                    },
                    …
                ]
            },
            …
        ]
    },
    …
]

Response Codes

200 - Request successful. Access policies in response body.

For more information, please see Common Response Codes.

POST AccessPolicies/Test

Purpose

Tests access to a managed account and returns a list of Password Safe access policies that are available in the request window.

Required Roles

Requestor role.

Request Body

Content-Type: application/json

{
    SystemId: int, 
    AccountId: int, 
    DurationMinutes : int
}

Response Body

Content-Type: application/json

[
    {
        AccessPolicyID:int,
        Name:string,
        Description:string,
        Schedules :
        [
            {
                ScheduleID : int,
                RequireReason : bool,
                RequireTicketSystem : bool,
                TicketSystemID : short?,
                AccessTypes :
                [
                    {
                        AccessType : string,
                        IsSession : bool,
                        RecordSession : bool,
                        MinApprovers : int,
                        MaxConcurrent : int
                    },
                    …
                ]
            },
            …
        ]
    },
    …
]

Response Codes

• 200 - Request successful. Access policies in response body.
• 403 - User does not have permissions to request the indicated account or the account does not have API access enabled. Response body contains a status code indicating the reason for this forbidden access:
  • 4031 - User does not have permission to request the account or the account is not valid for the system.

For more information, please see Common Response Codes.