Confluence Entitlement
Overview
Entitlement resource in IDHub maps to Group and Space in Confluence.
Groups contain members that indicate the User Accounts that are part of the Group. After creating a Group in Confluence, the Group is updated using PATCH to add User Accounts as members.
Spaces contain permissions for different users/groups. The user/group having “read space” permission is able to access the space. The user/group having “administer space” permission can modify the space permissions. When creating a space if no permission is specified, then all permissions for all existing groups and admin users are created. Permissions for a group/user can be revoked/modified/added as per requirement.
Note : Only users that have “read space” permissions are considered for current scope.
Entitlement Resource Schema Configuration
After creating a directory in the Confluence Admin account for a specific domain, the provisioning APIs for the Group Resource can be called using the directoryId. For Spaces, Confluence Cloud Rest APIs need to be called.
Entitlement Resource Type
The Entitlement resource type schema is as follows :
{
"schemas" : [
"urn:ietf:params:scim:schemas:core:2.0:ResourceType"
],
"id" : "Entitlement",
"name" : "Entitlement",
"description" : "This resource creates/modifies/deletes Entitlements in Confluence and returns your query to you in some form depending on the normal format of the endpoint (Resource or ListResponse).",
"endpoint" : "Entitlements",
"schema" : "urn:sath:params:scim:api:confluence:1.0:Entitlement"
}
Entitlement Schema Representation
The Entitlement schema is as follows :
{
"schemas" : [
"urn:ietf:params:scim:schemas:core:2.0:Schema"
],
"id" : "urn:sath:params:scim:api:confluence:1.0:Entitlement",
"name" : "Entitlement",
"description" : "To perform operations on confluence Entitlements like group membership/ space permissions",
"attributes" : [
{
"name" : "description",
"multiValued" : false,
"description" : "The description of the Entitlement. If Kind = GROUP, description is This is a Confluence Group. If Kind = SPACE, description is This is a Confluence Space. OPTIONAL."
},
{
"name" : "displayName",
"multiValued" : false,
"description" : "The displayName of the Entitlement. Format: Kind~<Entitlement Name>. REQUIRED.",
"required" : true
},
{
"name" : "externalId",
"multiValued" : false,
"description" : "A String that is an identifier for the resource as defined by the provisioning client. The \"externalId\" may simplify identification of a resource between the provisioning client and the service provider by allowing the client to use a filter to locate the resource with an identifier from the provisioning domain, obviating the need to store a local mapping between the provisioning domain's identifier of the resource and the identifier used by the service provider. Each resource MAY include a non-empty \"externalId\" value. The value of the \"externalId\" attribute is always issued by the provisioning client and MUST NOT be specified by the service provider. The service provider MUST always interpret the externalId as scoped to the provisioning domain. While the server does not enforce uniqueness, it is assumed that the value's uniqueness is controlled by the client setting the value. See Section 9 for additional considerations regarding privacy. This attribute has \"caseExact\" as \"true\" and a mutability of \"readWrite\". This attribute is OPTIONAL.\n",
"mutability" : "readOnly",
"returned" : "always",
"caseExact" : true
},
{
"name" : "id",
"multiValued" : false,
"description" : "The complex id of the Entitlement. Format: Kind~<EntitlementID>.REQUIRED.",
"returned" : "always",
"caseExact" : true,
"required" : true
},
{
"name" : "meta",
"multiValued" : false,
"description" : "A complex attribute containing resource metadata.",
"mutability" : "readOnly",
"subAttributes" : [
{
"name" : "resourceType",
"multiValued" : false,
"description" : "The name of the resource type of the resource.",
"mutability" : "readOnly",
"caseExact" : true
},
{
"name" : "created",
"multiValued" : false,
"type" : "dateTime",
"description" : "The \"DateTime\" that the resource was added to the service provider."
},
{
"name" : "lastModified",
"multiValued" : false,
"type" : "dateTime",
"description" : "The most recent DateTime that the details of this resource were updated at the service provider. If this resource has never been modified since its initial creation, the value MUST be the same as the value of \"created\"."
},
{
"name" : "location",
"multiValued" : false,
"description" : "The name of the resource type of the resource.",
"mutability" : "readOnly",
"caseExact" : true
},
{
"name" : "version",
"multiValued" : false,
"description" : "The version of the resource being returned. This value must be the same as the entity-tag (ETag) HTTP response header (see Sections 2.1 and 2.3 of [RFC7232]). This attribute has \"caseExact\" as \"true\". Service provider support for this attribute is optional and subject to the service provider's support for versioning (see Section 3.14 of [RFC7644]). If a service provider provides \"version\" (entity-tag) for a representation and the generation of that entity-tag does not satisfy all of the characteristics of a strong validator (see Section 2.1 of [RFC7232]), then the origin server MUST mark the \"version\" (entity-tag) as weak by prefixing its opaque value with \"W/\" (case sensitive).",
"mutability" : "readOnly",
"caseExact" : true
}
]
},
{
"name" : "schemas",
"multiValued" : true,
"description" : "The \"schemas\" attribute is a REQUIRED attribute and is an array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure. This attribute may be used by parsers to define the attributes present in the JSON structure that is the body to an HTTP request or response. Each String value must be a unique URI. All representations of SCIM schemas MUST include a non-empty array with value(s) of the URIs supported by that representation. The \"schemas\" attribute for a resource MUST only contain values defined as \"schema\" and \"schemaExtensions\" for the resource's defined \"resourceType\". Duplicate values MUST NOT be included. Value order is not specified and MUST NOT impact behavior.",
"mutability" : "readOnly",
"returned" : "always",
"caseExact" : true,
"required" : true
}
]
}
Schema to create different entitlements
For creating different entitlements, the payload should be compatible with the schema representation of the different resources as in Confluence.
Note : 1. CRUD operations on entitlements are not part of current scope
2. Only global spaces are in scope
Group Schema Representation | Space Schema Representation |
---|---|
CODE
|
CODE
|
Permission Schema
The following combinations of operation.key
and operation.target
values are valid for the operation
object:
'create': 'page', 'blogpost', 'comment', 'attachment'
'read': 'space'
'delete': 'page', 'blogpost', 'comment', 'attachment'
'export': 'space'
'administer': 'space'
Schema Representation | Sample Permission Payload |
---|---|
CODE
|
CODE
|
#Note : Space permissions cannot be modified in free Atlassian Access
Implementation
The following methods of the target system connector interface defined in the connector SPI needs to be implemented for Entitlement(Group, Space) resource.
Get Schema
CODE
|
Get Resource Type
CODE
|
Get SCIM Resource Service Information
CODE
|
Get Health
CODE
|
Create Resource
CODE
|
Get Resource
CODE
|
Replace Resource
CODE
|
Update Resource
CODE
|
Delete Resource
CODE
|
Search Resource
CODE
|