Swagger UIswagger

Udaru API Documentation
 5.3.2 

[ Base URL: localhost:8080/ ]

This page documents Udaru’s API endpoints, along with their various inputs and outputs. For more information about Udaru please see the Documentation Site.

policies
Manage policy objects

GET/authorization/policies
Fetch all the defined policies
POST/authorization/policies
Create a policy for the current user organization
GET/authorization/shared-policies
Fetch all the defined shared policies
POST/authorization/shared-policies
Create a policy shared across organizations
GET/authorization/policies/search
Search for organization policies
GET/authorization/policies/{id}
Fetch a single policy by ID
DELETE/authorization/policies/{id}
Delete a policy
PUT/authorization/policies/{id}
Update a policy of the current user organization
GET/authorization/shared-policies/search
Search for shared policies
GET/authorization/shared-policies/{id}
Fetch a single shared policy
DELETE/authorization/shared-policies/{id}
Delete a shared policy
PUT/authorization/shared-policies/{id}
Update a shared policy
GET/authorization/policies/{id}/variables
Fetch a template policy's variables
GET/authorization/policies/{id}/instances
List the instances of a policy assigned to users/teams and orgs
GET/authorization/shared-policies/{id}/variables
Fetch a template shared policy's variables
GET/authorization/shared-policies/{id}/instances
List the instances of a shared policy assigned to users/teams and orgs

organizations
Manage organizations

GET/authorization/organizations
List all the organizations
POST/authorization/organizations
Create an organization
DELETE/authorization/organizations/{id}
DELETE an organization
PUT/authorization/organizations/{id}
Update an organization
GET/authorization/organizations/{id}/policies
Fetch organization policies given its identifier
POST/authorization/organizations/{id}/policies
Clear and replace the policies of an organization
DELETE/authorization/organizations/{id}/policies
Clear all policies of the organization
PUT/authorization/organizations/{id}/policies
Add/update organization policy associations (specify instance to update)
DELETE/authorization/organizations/{id}/policies/{policyId}
Remove a policy associated with an organization

teams
Manage teams within an organization

GET/authorization/teams
Fetch all teams from the current user organization
POST/authorization/teams
Create a team
GET/authorization/teams/search
Search for teams from the current user organization
GET/authorization/teams/{id}
Fetch a team given its identifier
DELETE/authorization/teams/{id}
Delete a team
PUT/authorization/teams/{id}
Update a team
GET/authorization/teams/{id}/policies
Fetch team policies given its identifier
POST/authorization/teams/{id}/policies
Clear and replace policies for a team
DELETE/authorization/teams/{id}/policies
Clear all team policies
PUT/authorization/teams/{id}/policies
Add/update team policy associations (specify instance to update)
GET/authorization/teams/{id}/users
Fetch team users given its identifier
POST/authorization/teams/{id}/users
Replace team users with the given ones
DELETE/authorization/teams/{id}/users
Delete all team users
GET/authorization/teams/{id}/nested
Fetch a nested team given its identifier
GET/authorization/teams/{id}/users/search
Search for users in a team from the current user organization
DELETE/authorization/teams/{teamId}/policies/{policyId}
Remove a policy associated with a team
DELETE/authorization/teams/{id}/users/{userId}
Delete one team member

users
Manage users within an organization

GET/authorization/users
Fetch all users from the current user organization
POST/authorization/users
Create a new user
GET/authorization/users/search
Search for users from the current organization
GET/authorization/users/{id}
Fetch a user given its identifier
DELETE/authorization/users/{id}
Delete a user
PUT/authorization/users/{id}
Update a user
GET/authorization/users/{id}/teams
Fetch all teams to which the user belongs to. Does not fetch parent teams.
POST/authorization/users/{id}/teams
Clear and replace user teams
DELETE/authorization/users/{id}/teams
Delete teams for a user
GET/authorization/users/{id}/policies
Fetch user policies given its identifier
POST/authorization/users/{id}/policies
Clear and replace policies for a user
DELETE/authorization/users/{id}/policies
Clear all user's policies
PUT/authorization/users/{id}/policies
Add/update user policy associations (specify instance to update)
DELETE/authorization/users/{userId}/policies/{policyId}
Remove a policy associated with a user

authorization
Manage the actions a user can perform against a resource

GET/authorization/list/{userId}
List all the actions a user can perform on a list of resources
GET/authorization/list/{userId}/{resource*}
List all the actions a user can perform on a resource
GET/authorization/access/{userId}/{action}/{resource*}
Authorize user action against a resource
POST/authorization/access/{userId}
Authorize a batch of action/resource pairss

private
Endpoints that require a service key

POST/authorization/policies
Create a policy for the current user organization
POST/authorization/shared-policies
Create a policy shared across organizations
DELETE/authorization/policies/{id}
Delete a policy
PUT/authorization/policies/{id}
Update a policy of the current user organization
DELETE/authorization/shared-policies/{id}
Delete a shared policy
PUT/authorization/shared-policies/{id}
Update a shared policy

monitoring
Endpoints for monitoring and uptime

GET/ping
Ping endpoint

Models

MetaData
Variables
PolicyRef
PolicyRefs
Organization
Organizations
PagedOrganizations
Actions
Resources
Condition operator used when evaluating effect
Statement
Statements
PolicyStatements
Policy
Policies
PagedPolicies
UserRef
UserRefs
Team
Teams
PagedTeams
TeamRef
TeamRefs
User
Users
PagedUsers
UserActionsArray
UserActionOnResource
UserActionsOnResources
Short Team
Data
FilteredTeams
SearchUserList
UserActions
PagedPolicyRefs
PolicyInstance
Policy Instances
Nested Team
Nested Teams
NestedPagedTeams
PagedTeamRefs
Access
UserPayload
CreateOrgPayload
OrganizationAndUser
Action
Resource
StatementObject
StatementsArray
StatementsObject
CreatePolicyPayload
CreateSharedPoliciesPayload
CreateTeamPayload
CreateUserPayload
ResourceAccess
ResourceBatch
ResourceBatchPayload
BatchAccess
BatchAccessList
variables
PolicyIdObject
PolicyIdsArray
ReplaceOrgPoliciesPayload
ReplaceTeamPoliciesPayload
UsersArray
ReplaceTeamUsersPayload
ReplaceUserPoliciesPayload
TeamsArray
ReplaceUserTeamsPayload
UpdateOrgPayload
UpdatePolicyPayload
UpdateSharedPolicyPayload
UpdateTeamPayload
UpdateUserPayload
AddPoliciesToOrgPayload
AddPoliciesToTeamPayload
AddTeamUsersPayload
NestTeamPayload
AddUserPoliciesPayload