Shield

Version: 0.1.0

/v1beta1/actions

GET

Summary

Get all Actions

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListActionsResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Action

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1ActionRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateActionResponse
default	An unexpected error response.	rpcStatus

/v1beta1/check

POST

Summary

check permission for action on a resource by an user

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1CheckResourcePermissionRequest

Responses

Code	Description	Schema
200	A successful response.	v1beta1CheckResourcePermissionResponse
default	An unexpected error response.	rpcStatus

/v1beta1/groups

GET

Summary

Get all Groups

Parameters

Name	Located in	Description	Required	Schema
userId	query		No	string
orgId	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListGroupsResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Group

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1GroupRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateGroupResponse
default	An unexpected error response.	rpcStatus

/v1beta1/groups/{id}

GET

Summary

Get Group by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1GetGroupResponse
default	An unexpected error response.	rpcStatus

PUT

Summary

Update Group by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string
body	body		Yes	v1beta1GroupRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1UpdateGroupResponse
default	An unexpected error response.	rpcStatus

/v1beta1/groups/{id}/relations

GET

Summary

Get all relations for a group

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string
subjectType	query		No	string
role	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListGroupRelationsResponse
default	An unexpected error response.	rpcStatus

/v1beta1/metadatakey

POST

Summary

Create Metadata Key

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1MetadataKeyRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateMetadataKeyResponse
default	An unexpected error response.	rpcStatus

/v1beta1/namespaces

GET

Summary

Get all Namespaces

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListNamespacesResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Namespace

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1NamespaceRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateNamespaceResponse
default	An unexpected error response.	rpcStatus

/v1beta1/namespaces/{id}

GET

Summary

Get Namespace by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1GetNamespaceResponse
default	An unexpected error response.	rpcStatus

PUT

Summary

Update Namespace by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string
body	body		Yes	v1beta1NamespaceRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1UpdateNamespaceResponse
default	An unexpected error response.	rpcStatus

/v1beta1/object/{objectId}/subject/{subjectId}/role/{role}

DELETE

Summary

Remove a subject having a role from an object

Parameters

Name	Located in	Description	Required	Schema
objectId	path		Yes	string
subjectId	path		Yes	string
role	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1DeleteRelationResponse
default	An unexpected error response.	rpcStatus

/v1beta1/organizations

GET

Summary

Get all Organization

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListOrganizationsResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Organization

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1OrganizationRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateOrganizationResponse
default	An unexpected error response.	rpcStatus

/v1beta1/organizations/{id}

GET

Summary

Get Organization by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1GetOrganizationResponse
default	An unexpected error response.	rpcStatus

PUT

Summary

Update Organization by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string
body	body		Yes	v1beta1OrganizationRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1UpdateOrganizationResponse
default	An unexpected error response.	rpcStatus

/v1beta1/organizations/{id}/admins

GET

Summary

Get all Admins of an Organization

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListOrganizationAdminsResponse
default	An unexpected error response.	rpcStatus

/v1beta1/policies

GET

Summary

Get all Policy

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListPoliciesResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Policy

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1PolicyRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreatePolicyResponse
default	An unexpected error response.	rpcStatus

/v1beta1/projects

GET

Summary

Get all Project

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListProjectsResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Project

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1ProjectRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateProjectResponse
default	An unexpected error response.	rpcStatus

/v1beta1/projects/{id}

GET

Summary

Get Project by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1GetProjectResponse
default	An unexpected error response.	rpcStatus

PUT

Summary

Update Project by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string
body	body		Yes	v1beta1ProjectRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1UpdateProjectResponse
default	An unexpected error response.	rpcStatus

/v1beta1/projects/{id}/admins

GET

Summary

Get all Admins of a Project

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListProjectAdminsResponse
default	An unexpected error response.	rpcStatus

/v1beta1/relations

GET

Summary

Get all Relations

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListRelationsResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Relation

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1RelationRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateRelationResponse
default	An unexpected error response.	rpcStatus

/v1beta1/relations/{id}

GET

Summary

Get Relation by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1GetRelationResponse
default	An unexpected error response.	rpcStatus

/v1beta1/resources

GET

Summary

Get all Resources

Parameters

Name	Located in	Description	Required	Schema
groupId	query		No	string
projectId	query		No	string
organizationId	query		No	string
namespaceId	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListResourcesResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Resource

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1ResourceRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateResourceResponse
default	An unexpected error response.	rpcStatus

/v1beta1/resources/{id}

GET

Summary

Get Resource by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1GetResourceResponse
default	An unexpected error response.	rpcStatus

PUT

Summary

Update Resource by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string
body	body		Yes	v1beta1ResourceRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1UpdateResourceResponse
default	An unexpected error response.	rpcStatus

/v1beta1/roles

GET

Summary

Get all Roles

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListRolesResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create Role

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1RoleRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateRoleResponse
default	An unexpected error response.	rpcStatus

/v1beta1/users

GET

Summary

Get All Users

Parameters

Name	Located in	Description	Required	Schema
pageSize	query		No	integer
pageNum	query		No	integer
keyword	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListUsersResponse
default	An unexpected error response.	rpcStatus

POST

Summary

Create User

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1UserRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1CreateUserResponse
default	An unexpected error response.	rpcStatus

/v1beta1/users/self

GET

Summary

Get current user

Responses

Code	Description	Schema
200	A successful response.	v1beta1GetCurrentUserResponse
default	An unexpected error response.	rpcStatus

PUT

Summary

Update current User

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v1beta1UserRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1UpdateCurrentUserResponse
default	An unexpected error response.	rpcStatus

/v1beta1/users/{id}

GET

Summary

Get a User by id

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1GetUserResponse
default	An unexpected error response.	rpcStatus

PUT

Summary

Update User by ID

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string
body	body		Yes	v1beta1UserRequestBody

Responses

Code	Description	Schema
200	A successful response.	v1beta1UpdateUserResponse
default	An unexpected error response.	rpcStatus

/v1beta1/users/{id}/groups

GET

Summary

List Groups of a User

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string
role	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v1beta1ListUserGroupsResponse
default	An unexpected error response.	rpcStatus

Models

CheckResourcePermissionResponseResourcePermissionResponse

Name	Type	Description	Required
objectId	string		No
objectNamespace	string		No
permission	string		No
allowed	boolean		No

protobufAny

Name	Type	Description	Required
@type	string		No

protobufNullValue

NullValue is a singleton enumeration to represent the null value for the Value type union.

The JSON representation for NullValue is JSON null.

• NULL_VALUE: Null value.

Name	Type	Description	Required
protobufNullValue	string	NullValue is a singleton enumeration to represent the null value for the Value type union. The JSON representation for NullValue is JSON null. - NULL_VALUE: Null value.

rpcStatus

Name	Type	Description	Required
code	integer		No
message	string		No
details	[ protobufAny ]		No

v1beta1Action

Name	Type	Description	Required
id	string		No
name	string		No
namespace	v1beta1Namespace		No
createdAt	dateTime		No
updatedAt	dateTime		No
namespaceId	string		No

v1beta1ActionRequestBody

Name	Type	Description	Required
id	string		No
name	string		No
namespaceId	string		No

v1beta1CheckResourcePermissionRequest

Name	Type	Description	Required
objectId	string		No
objectNamespace	string		No
permission	string		No
resourcePermissions	[ v1beta1ResourcePermission ]		No

v1beta1CheckResourcePermissionResponse

Name	Type	Description	Required
status	boolean		No
resourcePermissions	[ CheckResourcePermissionResponseResourcePermissionResponse ]		No

v1beta1CreateActionResponse

Name	Type	Description	Required
action	v1beta1Action		No

v1beta1CreateGroupResponse

Name	Type	Description	Required
group	v1beta1Group		No

v1beta1CreateMetadataKeyResponse

Name	Type	Description	Required
metadatakey	v1beta1MetadataKey		No

v1beta1CreateNamespaceResponse

Name	Type	Description	Required
namespace	v1beta1Namespace		No

v1beta1CreateOrganizationResponse

Name	Type	Description	Required
organization	v1beta1Organization		No

v1beta1CreatePolicyResponse

Name	Type	Description	Required
policies	[ v1beta1Policy ]		No

v1beta1CreateProjectResponse

Name	Type	Description	Required
project	v1beta1Project		No

v1beta1CreateRelationResponse

Name	Type	Description	Required
relation	v1beta1Relation		No

v1beta1CreateResourceResponse

Name	Type	Description	Required
resource	v1beta1Resource		No

v1beta1CreateRoleResponse

Name	Type	Description	Required
role	v1beta1Role		No

v1beta1CreateUserResponse

Name	Type	Description	Required
user	v1beta1User		No

v1beta1DeleteRelationResponse

Name	Type	Description	Required
message	string		No

v1beta1GetCurrentUserResponse

Name	Type	Description	Required
user	v1beta1User		No

v1beta1GetGroupResponse

Name	Type	Description	Required
group	v1beta1Group		No

v1beta1GetNamespaceResponse

Name	Type	Description	Required
namespace	v1beta1Namespace		No

v1beta1GetOrganizationResponse

Name	Type	Description	Required
organization	v1beta1Organization		No

v1beta1GetProjectResponse

Name	Type	Description	Required
project	v1beta1Project		No

v1beta1GetRelationResponse

Name	Type	Description	Required
relation	v1beta1Relation		No

v1beta1GetResourceResponse

Name	Type	Description	Required
resource	v1beta1Resource		No

v1beta1GetUserResponse

Name	Type	Description	Required
user	v1beta1User		No

v1beta1Group

Name	Type	Description	Required
id	string		No
name	string		No
slug	string		No
orgId	string		No
metadata	object		No
createdAt	dateTime		No
updatedAt	dateTime		No

v1beta1GroupRelation

Name	Type	Description	Required
subjectType	string		No
role	string		No
user	v1beta1User		No
group	v1beta1Group		No

v1beta1GroupRequestBody

Name	Type	Description	Required
name	string		No
slug	string		No
metadata	object		No
orgId	string		No

v1beta1ListActionsResponse

Name	Type	Description	Required
actions	[ v1beta1Action ]		No

v1beta1ListGroupRelationsResponse

Name	Type	Description	Required
relations	[ v1beta1GroupRelation ]		No

v1beta1ListGroupsResponse

Name	Type	Description	Required
groups	[ v1beta1Group ]		No

v1beta1ListNamespacesResponse

Name	Type	Description	Required
namespaces	[ v1beta1Namespace ]		No

v1beta1ListOrganizationAdminsResponse

Name	Type	Description	Required
users	[ v1beta1User ]		No

v1beta1ListOrganizationsResponse

Name	Type	Description	Required
organizations	[ v1beta1Organization ]		No

v1beta1ListPoliciesResponse

Name	Type	Description	Required
policies	[ v1beta1Policy ]		No

v1beta1ListProjectAdminsResponse

Name	Type	Description	Required
users	[ v1beta1User ]		No

v1beta1ListProjectsResponse

Name	Type	Description	Required
projects	[ v1beta1Project ]		No

v1beta1ListRelationsResponse

Name	Type	Description	Required
relations	[ v1beta1Relation ]		No

v1beta1ListResourcesResponse

Name	Type	Description	Required
resources	[ v1beta1Resource ]		No

v1beta1ListRolesResponse

Name	Type	Description	Required
roles	[ v1beta1Role ]		No

v1beta1ListUserGroupsResponse

Name	Type	Description	Required
groups	[ v1beta1Group ]		No

v1beta1ListUsersResponse

Name	Type	Description	Required
count	integer		No
users	[ v1beta1User ]		No

v1beta1MetadataKey

Name	Type	Description	Required
key	string		No
description	string		No

v1beta1MetadataKeyRequestBody

Name	Type	Description	Required
key	string		No
description	string		No

v1beta1Namespace

Name	Type	Description	Required
id	string		No
name	string		No
createdAt	dateTime		No
updatedAt	dateTime		No

v1beta1NamespaceRequestBody

Name	Type	Description	Required
id	string		No
name	string		No

v1beta1Organization

Name	Type	Description	Required
id	string		No
name	string		No
slug	string		No
metadata	object		No
createdAt	dateTime		No
updatedAt	dateTime		No

v1beta1OrganizationRequestBody

Name	Type	Description	Required
name	string		No
slug	string		No
metadata	object		No

v1beta1Policy

Name	Type	Description	Required
id	string		No
role	v1beta1Role		No
action	v1beta1Action		No
namespace	v1beta1Namespace		No
createdAt	dateTime		No
updatedAt	dateTime		No
namespaceId	string		No
roleId	string		No
actionId	string		No

v1beta1PolicyRequestBody

Name	Type	Description	Required
roleId	string		No
actionId	string		No
namespaceId	string		No

v1beta1Project

Name	Type	Description	Required
id	string		No
name	string		No
slug	string		No
orgId	string		No
metadata	object		No
createdAt	dateTime		No
updatedAt	dateTime		No

v1beta1ProjectRequestBody

Name	Type	Description	Required
name	string		No
slug	string		No
metadata	object		No
orgId	string		No

v1beta1Relation

Name	Type	Description	Required
id	string		No
objectId	string		No
objectNamespace	string		No
subject	string		No
roleName	string		No
createdAt	dateTime		No
updatedAt	dateTime		No

v1beta1RelationRequestBody

Name	Type	Description	Required
objectId	string		No
objectNamespace	string		No
subject	string		No
roleName	string		No

v1beta1Resource

Name	Type	Description	Required
id	string		No
name	string		No
project	v1beta1Project		No
organization	v1beta1Organization		No
namespace	v1beta1Namespace		No
createdAt	dateTime		No
updatedAt	dateTime		No
user	v1beta1User		No
urn	string		No

v1beta1ResourcePermission

Name	Type	Description	Required
objectId	string		No
objectNamespace	string		No
permission	string		No

v1beta1ResourceRequestBody

Name	Type	Description	Required
name	string		No
projectId	string		No
namespaceId	string		No
relations	[ v1beta1Relation ]		No

v1beta1Role

Name	Type	Description	Required
id	string		No
name	string		No
types	[ string ]		No
namespace	v1beta1Namespace		No
metadata	object		No
createdAt	dateTime		No
updatedAt	dateTime		No
namespaceId	string		No

v1beta1RoleRequestBody

Name	Type	Description	Required
id	string		No
name	string		No
types	[ string ]		No
namespaceId	string		No
metadata	object		No

v1beta1UpdateCurrentUserResponse

Name	Type	Description	Required
user	v1beta1User		No

v1beta1UpdateGroupResponse

Name	Type	Description	Required
group	v1beta1Group		No

v1beta1UpdateNamespaceResponse

Name	Type	Description	Required
namespace	v1beta1Namespace		No

v1beta1UpdateOrganizationResponse

Name	Type	Description	Required
organization	v1beta1Organization		No

v1beta1UpdateProjectResponse

Name	Type	Description	Required
project	v1beta1Project		No

v1beta1UpdateResourceResponse

Name	Type	Description	Required
resource	v1beta1Resource		No

v1beta1UpdateUserResponse

Name	Type	Description	Required
user	v1beta1User		No

v1beta1User

Name	Type	Description	Required
id	string		No
name	string		No
slug	string		No
email	string		No
metadata	object		No
createdAt	dateTime		No
updatedAt	dateTime		No

v1beta1UserRequestBody

Name	Type	Description	Required
name	string		No
email	string		No
metadata	object		No