Skip to content

Latest commit

 

History

History
177 lines (131 loc) · 8.01 KB

ConditionSetRulesApi.md

File metadata and controls

177 lines (131 loc) · 8.01 KB

ConditionSetRulesApi

All URIs are relative to http://localhost

Method HTTP request Description
assignSetPermissions POST /v2/facts/{proj_id}/{env_id}/set_rules Assign Set Permissions
listSetPermissions GET /v2/facts/{proj_id}/{env_id}/set_rules List Set Permissions
unassignSetPermissions DELETE /v2/facts/{proj_id}/{env_id}/set_rules Unassign Set Permissions

assignSetPermissions

kotlin.collections.List<ConditionSetRuleRead> assignSetPermissions(projId, envId, conditionSetRuleCreate)

Assign Set Permissions

Grant permissions to a user set on a resource set. If the permission is already granted, it is skipped.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = ConditionSetRulesApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val conditionSetRuleCreate : ConditionSetRuleCreate =  // ConditionSetRuleCreate | 
try {
    val result : kotlin.collections.List<ConditionSetRuleRead> = apiInstance.assignSetPermissions(projId, envId, conditionSetRuleCreate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConditionSetRulesApi#assignSetPermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConditionSetRulesApi#assignSetPermissions")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
projId kotlin.String Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).
envId kotlin.String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).
conditionSetRuleCreate ConditionSetRuleCreate

Return type

kotlin.collections.List<ConditionSetRuleRead>

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listSetPermissions

kotlin.collections.List<ConditionSetRuleRead> listSetPermissions(projId, envId, userSet, permission, resourceSet, page, perPage)

List Set Permissions

Lists the condition set rules matching the filter. - If the `user_set` filter is present, will only return the permissions set of that user set. - If the `permission` filter is present, will only return the permissions sets that equals to the queried permission. - If the `resource_set` filter is present, will only return the permissions set of that resource set.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = ConditionSetRulesApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val userSet : kotlin.String = userSet_example // kotlin.String | optional user set filter, will only return rules where the permission is granted to this user set
val permission : kotlin.String = permission_example // kotlin.String | optional permission filter, will only return condition set rules granting this permission
val resourceSet : kotlin.String = resourceSet_example // kotlin.String | optional resource set filter, will only return rules where the permission is granted on this resource set
val page : kotlin.Int = 56 // kotlin.Int | Page number of the results to fetch, starting at 1.
val perPage : kotlin.Int = 56 // kotlin.Int | The number of results per page (max 100).
try {
    val result : kotlin.collections.List<ConditionSetRuleRead> = apiInstance.listSetPermissions(projId, envId, userSet, permission, resourceSet, page, perPage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConditionSetRulesApi#listSetPermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConditionSetRulesApi#listSetPermissions")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
projId kotlin.String Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).
envId kotlin.String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).
userSet kotlin.String optional user set filter, will only return rules where the permission is granted to this user set [optional]
permission kotlin.String optional permission filter, will only return condition set rules granting this permission [optional]
resourceSet kotlin.String optional resource set filter, will only return rules where the permission is granted on this resource set [optional]
page kotlin.Int Page number of the results to fetch, starting at 1. [optional] [default to 1]
perPage kotlin.Int The number of results per page (max 100). [optional] [default to 30]

Return type

kotlin.collections.List<ConditionSetRuleRead>

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

unassignSetPermissions

unassignSetPermissions(projId, envId, conditionSetRuleRemove)

Unassign Set Permissions

Revokes permissions to a user set on a resource set. If the permission is not granted, it is skipped.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = ConditionSetRulesApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val conditionSetRuleRemove : ConditionSetRuleRemove =  // ConditionSetRuleRemove | 
try {
    apiInstance.unassignSetPermissions(projId, envId, conditionSetRuleRemove)
} catch (e: ClientException) {
    println("4xx response calling ConditionSetRulesApi#unassignSetPermissions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConditionSetRulesApi#unassignSetPermissions")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
projId kotlin.String Either the unique id of the project, or the URL-friendly key of the project (i.e: the &quot;slug&quot;).
envId kotlin.String Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the &quot;slug&quot;).
conditionSetRuleRemove ConditionSetRuleRemove

Return type

null (empty response body)

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json