Jump to

• Request
• Response
• Examples

Retrieve Project RBAC Details

get

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

Retrieves Role-Based Access Control information about the project.

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular

200 Response

Successful operation

Body ()

Root Schema : AccessControlledRs

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"
        }
    }
}

404 Response

Project not found

500 Response

Server error

Back to Top

Examples

The following examples show how to get 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: Get RBAC details of a project TEST_PROJECT

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

Back to Top