Policy #

A Policy is a resource managing page access permissions. This resource can be used in all domains if it is defined in the repository microservice.

Package : spaceone.api.repository.v1

Policy #

Policy Methods:

Method	Request	Response
create	CreatePolicyRequest	PolicyInfo
update	UpdatePolicyRequest	PolicyInfo
delete	PolicyRequest	Empty
get	GetRepositoryPolicyRequest	PolicyInfo
list	PolicyQuery	PoliciesInfo
stat	PolicyStatQuery	Struct

create #

Creates a new Policy. The parameter policy_id, an identifier of Policy resources, can only include lowercase alphabets, numbers, and hyphens(-). The parameter permissions is a list type data describing page access permissions.

POST /repository/v1/policy/create

Request Example

CreatePolicyRequest

name (string) Required
permissions (string) Repeated Required
policy_id (string) Required
domain_id (string) Required
labels (ListValue)
tags (Struct)
project_id (string)

{
   "policy_id": "policy-custom-full-acess",
   "name": "Full Access",
   "permissions": ["*"],
   "labels": [],
   "tags": {},
   "domain_id": "domain-123456789012"
}

Response Example

PolicyInfo

policy_id (string) Required
name (string) Required
state (State) Required
permissions (string) Repeated Required
list of permissions
labels (ListValue) Required
list of labels
tags (Struct) Required
repository_info (RepositoryInfo) Required
project_id (string) Required
domain_id (string) Required
created_at (string) Required
updated_at (string) Required

{
   "policy_id": "policy-custom-full-acess",
   "name": "Full Access",
   "state": "ENABLED",
   "permissions": [
       "*"
   ],
   "labels": [],
   "tags": {},
   "repository_info": {
       "repository_id": "repo-123456789012",
       "name": "Local",
       "repository_type": "local"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:45:04.582Z",
   "updated_at": "2022-01-01T06:45:04.582Z"
}

update #

Updates a specific Policy. You can make changes in Policy settings, including name, labels, tags, and permissions. The parameter policy_id cannot be updated.

POST /repository/v1/policy/update

Request Example

UpdatePolicyRequest

policy_id (string) Required
domain_id (string) Required
name (string)
permissions (string) Repeated
labels (ListValue)
tags (Struct)

{
   "policy_id": "policy-custom-full-acess",
   "name": "Full Access",
   "permissions": ["*"],
   "labels": [],
   "tags": {},
   "domain_id": "domain-123456789012"
}

Response Example

PolicyInfo

policy_id (string) Required
name (string) Required
state (State) Required
permissions (string) Repeated Required
list of permissions
labels (ListValue) Required
list of labels
tags (Struct) Required
repository_info (RepositoryInfo) Required
project_id (string) Required
domain_id (string) Required
created_at (string) Required
updated_at (string) Required

{
   "policy_id": "policy-custom-full-acess",
   "name": "Full Access",
   "state": "ENABLED",
   "permissions": [
       "*"
   ],
   "labels": [],
   "tags": {},
   "repository_info": {
       "repository_id": "repo-123456789012",
       "name": "Local",
       "repository_type": "local"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:45:04.582Z",
   "updated_at": "2022-01-01T06:45:04.582Z"
}

delete #

Deletes a specific Policy. You must specify the policy_id of the Policy to delete, as the policy_id is an identifier of Policy resources.

POST /repository/v1/policy/delete

Request Example

PolicyRequest

policy_id (string) Required
domain_id (string) Required

{
   "policy_id": "policy-123456789012"
}

get #

Gets a specific Policy. You must specify the policy_id of the Policy to get, as the policy_id is an identifier of Policy resources. You can use the parameter repository_id to limit the scope of the method to a specific Repository.

POST /repository/v1/policy/get

Request Example

GetRepositoryPolicyRequest

policy_id (string) Required
domain_id (string) Required
repository_id (string)
only (string) Repeated

{
   "policy_id": "policy-123456789012",
   "repository_id": "repo-123456789012"
}

Response Example

PolicyInfo

policy_id (string) Required
name (string) Required
state (State) Required
permissions (string) Repeated Required
list of permissions
labels (ListValue) Required
list of labels
tags (Struct) Required
repository_info (RepositoryInfo) Required
project_id (string) Required
domain_id (string) Required
created_at (string) Required
updated_at (string) Required

{
   "policy_id": "policy-custom-full-acess",
   "name": "Full Access",
   "state": "ENABLED",
   "permissions": [
       "*"
   ],
   "labels": [],
   "tags": {},
   "repository_info": {
       "repository_id": "repo-123456789012",
       "name": "Local",
       "repository_type": "local"
   },
   "domain_id": "domain-123456789012",
   "created_at": "2022-01-01T06:45:04.582Z",
   "updated_at": "2022-01-01T06:45:04.582Z"
}

list #

Gets a list of all Policies in a specific Repository. The parameter repository_id is used as an identifier of a Repository to get its list of Policies. You can use a query to get a filtered list of Policies.

POST /repository/v1/policy/list

Request Example

PolicyQuery

repository_id (string) Required
domain_id (string) Required
query (Query)
policy_id (string)
name (string)
project_id (string)
state (State)

{
   "query": {},
   "repository_id": "repo-123456789012"
}

Response Example

PoliciesInfo

results (PolicyInfo) Repeated Required
list of PolicyInfo
total_count (int32) Required

{
   "results": [
       {
           "policy_id": "policy-123456789012",
           "name": "Full Access",
           "state": "ENABLED",
           "permissions": [
               "*"
           ],
           "labels": [],
           "tags": {},
           "repository_info": {
               "repository_id": "repo-123456789012",
               "name": "Local",
               "repository_type": "local"
           },
           "domain_id": "domain-123456789012",
           "created_at": "2022-01-01T15:42:50.943Z",
           "updated_at": "2022-01-01T15:42:50.943Z"
       },
       {
           "policy_id": "policy-987654321098",
           "name": "Identity Admin",
           "state": "ENABLED",
           "permissions": [
               "identity.*"
           ],
           "labels": [],
           "tags": {},
           "repository_info": {
               "repository_id": "repo-123456789012",
               "name": "Local",
               "repository_type": "local"
           },
           "domain_id": "domain-123456789012",
           "created_at": "2022-01-01T08:08:14.756Z",
           "updated_at": "2022-01-01T08:08:14.756Z"
       }
   ],
   "total_count": 2
}

stat #

POST /repository/v1/policy/stat

Message #

CreatePolicyRequest #

name (string) Required
permissions (string) Repeated Required
policy_id (string) Required
domain_id (string) Required
labels (ListValue)
tags (Struct)
project_id (string)

GetRepositoryPolicyRequest #

policy_id (string) Required
domain_id (string) Required
repository_id (string)
only (string) Repeated

PoliciesInfo #

results (PolicyInfo) Repeated Required
list of PolicyInfo
total_count (int32) Required

PolicyInfo #

policy_id (string) Required
name (string) Required
state (State) Required
permissions (string) Repeated Required
list of permissions
labels (ListValue) Required
list of labels
tags (Struct) Required
repository_info (RepositoryInfo) Required
project_id (string) Required
domain_id (string) Required
created_at (string) Required
updated_at (string) Required

PolicyQuery #

repository_id (string) Required
domain_id (string) Required
query (Query)
policy_id (string)
name (string)
project_id (string)
state (State)

PolicyRequest #

policy_id (string) Required
domain_id (string) Required

PolicyStatQuery #

query (StatisticsQuery) Required
repository_id (string) Required
domain_id (string) Required

UpdatePolicyRequest #

policy_id (string) Required
domain_id (string) Required
name (string)
permissions (string) Repeated
labels (ListValue)
tags (Struct)