Jump to

• Request
• Response
• Examples

Update Project RBAC Details

put

/ic/api/integration/v1/projects/{id}/acl

Updates Role-Based Access Control details of the project. The request body must contain:

• administrators: specifies the owners of the project. For example:

  "administrators":{"allowAll":false,"allowed":[{"id":"123456abcdef","displayName":"test admin user","type":"user"},{"id":"654321abcdef","displayName":"ServiceAdministrator","type": "group"}]}

• editors: specifies who can edit the project. For example:

  "editors":{"allowAll":false,"allowed":[{"id":"234561abcdef","displayName":"test developer user","type":"user"},{"id":"123456abcdef","displayName":"test admin user","type": "user"}]}

• viewers: specifies who can view the project. If everyone can view the project allowAll can be set to true and allowed list can be empty. For example:

  "viewers":{"allowAll":true,"allowed":[]}

• monitors: specifies who can monitor the project. For example:

  "monitors":{"allowAll":true,"allowed":[]}

Request

Path Parameters

• id(required): string
  Project identifier

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• administrators: object AclRoleRs
• created-by: string
  Created By
• created-date: string (date-time)
  Created Date
• editors: object AclRoleRs
• monitors: object AclRoleRs
• updated-by: string
  Updated By
• updated-date: string (date-time)
  Updated Date
• viewers: object AclRoleRs

{
    "type":"object",
    "properties":{
        "updated-by":{
            "type":"string",
            "description":"Updated By"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "created-date":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "updated-date":{
            "type":"string",
            "description":"Updated Date",
            "format":"date-time"
        },
        "administrators":{
            "description":"Administrators List",
            "$ref":"#/components/schemas/AclRoleRs"
        },
        "editors":{
            "description":"Editors List",
            "$ref":"#/components/schemas/AclRoleRs"
        },
        "viewers":{
            "description":"Viewers List",
            "$ref":"#/components/schemas/AclRoleRs"
        },
        "monitors":{
            "description":"Monitors List",
            "$ref":"#/components/schemas/AclRoleRs"
        }
    }
}

Nested Schema : AclRoleRs

Type: object

Show Source

• allow-all(required): boolean
  Allow All Flag
• allowed(required): array allowed
  Allowed List

{
    "required":[
        "allow-all",
        "allowed"
    ],
    "type":"object",
    "properties":{
        "allow-all":{
            "type":"boolean",
            "description":"Allow All Flag"
        },
        "allowed":{
            "type":"array",
            "description":"Allowed List",
            "items":{
                "$ref":"#/components/schemas/AclRoleItem"
            }
        }
    }
}

Nested Schema : allowed

Type: array

Allowed List

Show Source

• Array of: object AclRoleItem

{
    "type":"array",
    "description":"Allowed List",
    "items":{
        "$ref":"#/components/schemas/AclRoleItem"
    }
}

Nested Schema : AclRoleItem

Type: object

Show Source

• display-name(required): string
  User/Group Display Name
• id(required): string
  User/Group Identifier
• id-not-found: boolean
  User/Group Id Not Found Flag
• type(required): string
  Type - User/Group

{
    "required":[
        "display-name",
        "id",
        "type"
    ],
    "type":"object",
    "properties":{
        "display-name":{
            "type":"string",
            "description":"User/Group Display Name"
        },
        "id":{
            "type":"string",
            "description":"User/Group Identifier"
        },
        "type":{
            "type":"string",
            "description":"Type - User/Group"
        },
        "id-not-found":{
            "type":"boolean",
            "description":"User/Group Id Not Found Flag"
        }
    }
}

Back to Top

Response

204 Response

Successful operation

404 Response

Project not found

500 Response

Server error

Back to Top

Examples

The following examples show how to update the RBAC details of a project by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Update RBAC details of the project TEST_PROJECT

curl -X PUT -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d
      @acl.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/acl?integrationInstance=service-instance

The following code sample shows the contents of the acl.json file listed in the cURL command.

Example: Request Body to update a user and a group as administrators, two users as editors, and everyone as viewer and monitor of the project

The id is the user/group id from IDCS.

{
  "administrators": {
    "allowAll": false,
    "allowed": [
      {
        "id": "123456abcdef",
        "displayName": "test admin user",
        "type": "user"
      },
      {
        "id": "654321abcdef",
        "displayName": "ServiceAdministrator",
        "type": "group"
      }
    ]
  },
  "editors": {
    "allowAll": false,
    "allowed": [
      {
        "id": "234561abcdef",
        "displayName": "test developer user",
        "type": "user"
      },
      {
        "id": "123456abcdef",
        "displayName": "test admin user",
        "type": "user"
      }
    ]
  },
  "viewers": {
    "allowAll": true,
    "allowed": [
    ]
  },
  "monitors": {
    "allowAll": true,
    "allowed": [
    ]
  }
}

Back to Top