AuthorizationAPI

Index

Interfaces

Type Aliases

Functions

Type Aliases

EffectEnum

EffectEnum: "allow" | "deny"

EntityTypeEnum

EntityTypeEnum: "user" | "app"

IdentityTypeEnum

IdentityTypeEnum: "user" | "app" | "group"

Relation

Relation: "home" | "reference"

The relation of the resource with the Project.

ResourceRelation

ResourceRelation: "home" | "reference"

The relation of the resource with the Project

StateEnum

StateEnum: "deleted" | "disabled" | "locked" | "enabled"

Type

The type of the resource

Functions

addGrant

addGrant(builder: RequestBuilder, params: {actionId: string; entityId: string; entityType: string; resourceHrn: string}): Promise<EntityGrant>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1293
Grant access to a resource to an entity. The result of this call is that the specified entity will have permission to take the specified action against the specified resource. Restrictions:
- The realm of the calling principal must match the realm of the requested entity.
- The calling principal must have permission to take the addGrant:{actionId} OR share action against the specified resource.
- Example: In order to add a grant for the readResource action against resource hrn:here:data:::my-shared-catalog a permission with the following would be required:
- "action" : "addGrant:readResource"
- "resource" : "hrn:here:data:::my-shared-catalog" OR
- "action" : "share"
- "resource" : "hrn:here:data:::my-shared-catalog"
- This API works only with tokens that are not scoped to a project.
summary
Grant access to a resource to an entity.
Parameters
- builder: RequestBuilder
- params: {actionId: string; entityId: string; entityType: string; resourceHrn: string}
 - actionId: string
 - entityId: string
 - entityType: string
 - resourceHrn: string
Returns Promise<EntityGrant>

addGroupMember

addGroupMember(builder: RequestBuilder, params: {groupId: string; member: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1862
Add a single member to a group.
Restrictions:
- The calling principal must have permission to take the manageMembers action against the group identified by the provided group HRN.
- Example: In order to add a member to the group, GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a, a permission with the following would be required:
- "action" : "manageMembers"
- "resource" : "hrn:here:authorization::myrealm:group/GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a"
- This API works only with tokens that are not scoped to a project.
summary
Add a member to a group
Parameters
- builder: RequestBuilder
- params: {groupId: string; member: string}
 - groupId: string
 - member: string
Returns Promise<Response>

addProjectMember

addProjectMember(builder: RequestBuilder, params: {member: string; project: string; xCorrelationID?: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2319
Add the member to the requested Project.
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the manageMembers action for the specified resource.
- Example: In order to add a member to the Project, the following permission would be required:
- "action" : "manageMembers"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Add the member to the requested Project
Parameters
- builder: RequestBuilder
- params: {member: string; project: string; xCorrelationID?: string}
 - member: string
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<Response>

addProjectResourceRelation

addProjectResourceRelation(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-resourcelinkactionbody" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ResourceLinkActionBody</a>; project: string; relation: <a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-authorizationapi#ResourceRelation" class="typedoc-tsd-signature-type" data-tsd-kind="Type alias">ResourceRelation</a>; resource: string; type: <a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-authorizationapi#Type" class="typedoc-tsd-signature-type" data-tsd-kind="Type alias">Type</a>; xCorrelationID?: string}): Promise<ResourceRelationResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2395
Add the resource to the requested Project as a home or a reference(link).
Access Control:
- User Access Token & Client Access Token When relation=home The requested resource will be assigned the requested project as its resource home. The resource MUST NOT already have an existing resource home.
- The calling principal must have permission to take the manageResourceHome action for the specified project AND the share action for the specified resource.
- Example: In order to add resource "hrn:here:data::myrealm:my-catalog-0000" to the project "hrn:here:authorization::myrealm:project/my-project-0000", the following permissions would be required:
- Permission 1:
- "action" : "manageResourceHome"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- Permission 2:
- "action" : "share"
- "resource" : "hrn:here:data::myrealm:my-catalog-0000" When relation=reference Link the resource to the requested Project as a reference(link). The requested resource will be assigned to the requested project as reference(link).
The resource MUST be available to the caller to attach as a resource reference(link). A resource is referenceable if it has been marked as referenceable and the caller has permission to all reference enabled actions against the resource OR The resource has been made linkable to the project/realm for the project linking enabled action The exclusive list of resources available to the caller to attach as a resource reference(link) is accessible via a call to /resources?referenceable=true or /resources?linkable=true
- The authorization context must satisfy one of the following:
- The calling principal has permission to take the manageResourceReferences action for the specified project.
- Example: In order to add a resource reference to the project "hrn:here:authorization::myrealm:project/my-project-0000", the following permission would be required:
- "action" : "manageResourceReferences"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- The calling principal is a member of the specified project.
- The calling principal must have permission to attach the resource as a referenceable resource. A resource is referenceable to the caller if:
- It has been marked as referenceable and The caller has permission to all reference enabled actions against the resource.
OR
- The resource has been made linkable to the project/realm for the project linking enabled action
- This API works only with tokens that are not scoped to a project.
summary
Add a resource to the requested Project as a Resource Home or Resource Reference(Link)
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-resourcelinkactionbody" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ResourceLinkActionBody</a>; project: string; relation: <a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-authorizationapi#ResourceRelation" class="typedoc-tsd-signature-type" data-tsd-kind="Type alias">ResourceRelation</a>; resource: string; type: <a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-authorizationapi#Type" class="typedoc-tsd-signature-type" data-tsd-kind="Type alias">Type</a>; xCorrelationID?: string}
 - body: ResourceLinkActionBody
 - project: string
 - relation: ResourceRelation
 - resource: string
 - type: Type
 - Optional xCorrelationID?: string
Returns Promise<ResourceRelationResponse>

addRoleEntity

addRoleEntity(builder: RequestBuilder, params: {entity: string; role: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1528
Assign the role provided to the given entity. If the provided role is associated with a group, the entity being assigned the role must be a member of the associated group. Restrictions:
- The calling principal must have permission to take the manageEntities action against the specified role.
- Example: In order to assign the role, GroupAdmin, to an entity a permission with the following would be required:
- "action" : "manageEntities"
- "resource" : "hrn:here:authorization::myrealm:role/ROLE-c1662138-a170-4264-ba18-7b506a708c37"
- This API works only with tokens that are not scoped to a project.
summary
Assign a role to an entity
Parameters
- builder: RequestBuilder
- params: {entity: string; role: string}
 - entity: string
 - role: string
Returns Promise<Response>

attachProjectPolicyToMember

attachProjectPolicyToMember(builder: RequestBuilder, params: {member: string; policy: string; project: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3576
Attaches the Project Policy to the member of the Project.
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the manageMembers action for the specified resource.
- Example: In order to attach a custom policy in a Project to a member, the following permissions would be required:
- "action" : "manageMembers"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000" AND
- "action" : "managePolicies"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Admins and Resource Managers
- This API works only with tokens that are not scoped to a project.
summary
Attach Project Policy to Member
Parameters
- builder: RequestBuilder
- params: {member: string; policy: string; project: string}
 - member: string
 - policy: string
 - project: string
Returns Promise<Response>

cancelRealmMemberInvite

cancelRealmMemberInvite(builder: RequestBuilder, params: {invite: string; realm: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1114
Cancel an invitation to the realm. Restrictions:
- The calling principal must have permission to take the manageInvites action against the specified realm.
example:
In order to delete an invitation to the realm, MyRealm, a permission with the following would be required:
- "action" : "manageInvites"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Cancel a user invitation to a realm
Parameters
- builder: RequestBuilder
- params: {invite: string; realm: string}
 - invite: string
 - realm: string
Returns Promise<Response>

checkProjectExistance

checkProjectExistance(builder: RequestBuilder, params: {project: string; xCorrelationID?: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2442
Checks whether a project exists with requested project hrn in caller realm.
If project does not exist in the same realm it will return 404.
- This API works only with tokens that are not scoped to a project.
summary
Checks the existance of a project in caller realm.
Parameters
- builder: RequestBuilder
- params: {project: string; xCorrelationID?: string}
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<Response>

createGroup

createGroup(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-group" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">Group</a>}): Promise<Group>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1898
Create a group within the realm that is associated with the calling party. The calling party will be made a member and an administrator of the created group.
Restrictions:
- The calling principal must have permission to take the createGroup action against the realm associated with the calling party.
- Example: In order to create a group within the calling party's realm a permission with the following would be required:
- "action" : "createGroup"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Create group
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-group" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">Group</a>}
 - body: Group
Returns Promise<Group>

createProject

createProject(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-projectrequest" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ProjectRequest</a>; xCorrelationID?: string}): Promise<ProjectResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2481
Create the requested Project in the callers realm Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the createProject action for the specified project.
- Example: In order to create a Project, the following permission would be required:
- "action" : "createProject"
- This API works only with tokens that are not scoped to a project.
summary
Create the requested Project
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-projectrequest" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ProjectRequest</a>; xCorrelationID?: string}
 - body: ProjectRequest
 - Optional xCorrelationID?: string
Returns Promise<ProjectResponse>

createProjectPolicy

createProjectPolicy(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-projectpolicyrequestbody" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ProjectPolicyRequestBody</a>; project: string}): Promise<ProjectPolicyResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3614
Create the requested custom policy in the Project
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the managePolicies action for the specified resource.
- Example: In order to create a custom policy in a Project, the following permission would be required:
- "action" : "managePolicies"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Admins and Resource Managers
- This API works only with tokens that are not scoped to a project.
summary
Create the requested Project Policy
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-projectpolicyrequestbody" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ProjectPolicyRequestBody</a>; project: string}
 - body: ProjectPolicyRequestBody
 - project: string
Returns Promise<ProjectPolicyResponse>

createRealmMemberInvite

createRealmMemberInvite(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-realmauthorizationinvite" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">RealmAuthorizationInvite</a>; realm: string}): Promise<RealmAuthInviteResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1156
Create and send an invitation to add a new member to the realm, optionally assign membership to one or more groups if the Inviter is also a GroupAdmin for the group. Restrictions:
- The calling principal must have permission to take the manageInvites action against the specified realm.
example:
In order to invite a new user to the realm, MyRealm, a permission with the following would be required:
- "action" : "manageInvites"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
example:
In order to invite a new user to the realm, MyRealm, as a member of the group GROUP-a3dee2fe-fb38-4183-b686-14fdea5964c0, the following permissions would be required:
- "action" : "manageInvites"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- "action" : "manageMembers"
- "resource" : "hrn:here:authorization::myrealm:group/GROUP-a3dee2fe-fb38-4183-b686-14fdea5964c"
- This API works only with tokens that are not scoped to a project.
summary
Create and send a user invitation for a realm
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-realmauthorizationinvite" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">RealmAuthorizationInvite</a>; realm: string}
 - body: RealmAuthorizationInvite
 - realm: string
Returns Promise<RealmAuthInviteResponse>

deleteGroup

deleteGroup(builder: RequestBuilder, params: {groupId: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1936
Delete the group identified by the provided group HRN.
Restrictions:
- The calling principal must have permission to take the deleteGroup action against the group identified by the provided group HRN.
- Example: In order to delete the group, GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a, a permission with the following would be required:
- "action" : "deleteGroup"
- "resource" : "hrn:here:authorization::myrealm:group/GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a"
- This API works only with tokens that are not scoped to a project.
summary
delete group
Parameters
- builder: RequestBuilder
- params: {groupId: string}
 - groupId: string
Returns Promise<Response>

deleteProject

deleteProject(builder: RequestBuilder, params: {project: string; xCorrelationID?: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2519
Delete the specified Project Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the manage action for the specified resource.
- Example: In order to delete a Project, the following permission would be required:
- "action" : "manage"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Delete the specified Project
Parameters
- builder: RequestBuilder
- params: {project: string; xCorrelationID?: string}
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<Response>

deleteProjectMember

deleteProjectMember(builder: RequestBuilder, params: {member: string; project: string; xCorrelationID?: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2559
Remove the member from the specified Project Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the manageMembers action for the specified resource.
- Example: In order to remove a member from a Project, the following permission would be required:
- "action" : "manageMembers"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Remove the member from the specified Project
Parameters
- builder: RequestBuilder
- params: {member: string; project: string; xCorrelationID?: string}
 - member: string
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<Response>

deleteProjectPolicy

deleteProjectPolicy(builder: RequestBuilder, params: {policy: string; project: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3657
Delete the custom policy in the Project
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the managePolicies action for the specified resource.
- Example: In order to update a custom policy in a Project, the following permission would be required:
- "action" : "managePolicies"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Admins and Resource Managers
- This API works only with tokens that are not scoped to a project.
summary
Delete the custom Project Policy
Parameters
- builder: RequestBuilder
- params: {policy: string; project: string}
 - policy: string
 - project: string
Returns Promise<Response>

deleteProjectResourceReference

deleteProjectResourceReference(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-resourcelinkactionbody" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ResourceLinkActionBody</a>; project: string; relation: string; resource: string; xCorrelationID?: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2604
Remove the resource from the project. The requested resource may only be linked as a reference, removing a home resource requires deleting the resource from the resource service.
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the manageResourceReferences action for the specified project.
- Example: In order to remove a resource reference(link) from the project "hrn:here:authorization::myrealm:project/my-project-0000", the following permission would be required:
- "action" : "manageResourceReferences"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Remove a Resource Reference(Link) from a project
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-resourcelinkactionbody" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ResourceLinkActionBody</a>; project: string; relation: string; resource: string; xCorrelationID?: string}
 - body: ResourceLinkActionBody
 - project: string
 - relation: string
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<Response>

deleteRoleEntity

deleteRoleEntity(builder: RequestBuilder, params: {entity: string; role: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1560
Remove the role provided to from the given member. Restrictions:
- The calling principal must have permission to take the manageEntities action against the specified role.
- Example: In order to revoke the role, GroupAdmin, from an entity a permission with the following would be required:
- "action" : "manageEntities"
- "resource" : "hrn:here:authorization::myrealm:role/ROLE-c1662138-a170-4264-ba18-7b506a708c37"
- This API works only with tokens that are not scoped to a project.
summary
Revoke a role from an entity
Parameters
- builder: RequestBuilder
- params: {entity: string; role: string}
 - entity: string
 - role: string
Returns Promise<Response>

detachProjectPolicyFromMember

detachProjectPolicyFromMember(builder: RequestBuilder, params: {member: string; policy: string; project: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3699
Detached the requested custom Project Policy from a Membber
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the manageMembers action for the specified resource.
- Example: In order to detach a custom policy in a Project from a member, the following permissions would be required:
- "action" : "manageMembers"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000" AND
- "action" : "managePolicies"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Admins and Resource Managers
- This API works only with tokens that are not scoped to a project.
summary
Detach the Project Policy from a Member
Parameters
- builder: RequestBuilder
- params: {member: string; policy: string; project: string}
 - member: string
 - policy: string
 - project: string
Returns Promise<Response>

getAllProjectList

getAllProjectList(builder: RequestBuilder, params: {limit?: number; pageToken?: string; xCorrelationID?: string}): Promise<ProjectListWithPageToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2655
Get the list of all Projects in the Org
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the listAllProjects action for the specified resource.
- Example: In order to get a list of projects, the following permission would be required:
- "action" : "listAllProjects"
- This API works only with tokens that are not scoped to a project.
summary
Get the list of all Projects in the Org
Parameters
- builder: RequestBuilder
- params: {limit?: number; pageToken?: string; xCorrelationID?: string}
 - Optional limit?: number
 - Optional pageToken?: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectListWithPageToken>

getAllProjectMembersWithAttachedPolicy

getAllProjectMembersWithAttachedPolicy(builder: RequestBuilder, params: {limit?: number; pageToken?: string; policy: string; project: string; xCorrelationID?: string}): Promise<ProjectMemberListWithPageToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3742
Get the list of all Project Members with the attached Policy
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to read the list of all members attached to a project policy, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins
- This API works only with tokens that are not scoped to a project.
summary
Get the list of all Project Members with the attached Policy
Parameters
- builder: RequestBuilder
- params: {limit?: number; pageToken?: string; policy: string; project: string; xCorrelationID?: string}
 - Optional limit?: number
 - Optional pageToken?: string
 - policy: string
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectMemberListWithPageToken>

getAttachedProjectPoliciesForMember

getAttachedProjectPoliciesForMember(builder: RequestBuilder, params: {limit?: number; member: string; pageToken?: string; project: string; xCorrelationID?: string}): Promise<ProjectPolicyListResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3794
Get the list of Attached Project Policies For a Member
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to read the list of the attached project policies, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins
- This API works only with tokens that are not scoped to a project.
summary
Get the list of Attached Project Policies For a Member
Parameters
- builder: RequestBuilder
- params: {limit?: number; member: string; pageToken?: string; project: string; xCorrelationID?: string}
 - Optional limit?: number
 - member: string
 - Optional pageToken?: string
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectPolicyListResponse>

getAttachedProjectPolicyForMember

getAttachedProjectPolicyForMember(builder: RequestBuilder, params: {member: string; policy: string; project: string}): Promise<AttachedPolicy>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3844
Get the attached Project Policy For a Member
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to read the attached project policy, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins
- This API works only with tokens that are not scoped to a project.
summary
Get the attached Project Policy for a Member
Parameters
- builder: RequestBuilder
- params: {member: string; policy: string; project: string}
 - member: string
 - policy: string
 - project: string
Returns Promise<AttachedPolicy>

getEntityGroupMembership

getEntityGroupMembership(builder: RequestBuilder, params: {count?: number; member: string; pageToken?: string; realm: string}): Promise<GroupPageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:938

Retrieve the groups a given entity is a member of. Restrictions: The calling principal must have permission to take the readGroups action against the specified entity.

example:
In order to retrieve the groups a user, HERE-4ba9aca3-fdf9-4cad-a3da-534494d6198f, is a member of, a permission with the following would be required: "action" : "readGroups" "resource" : "hrn:here:account::myrealm:user/HERE-4ba9aca3-fdf9-4cad-a3da-534494d6198f" This API works only with tokens that are not scoped to a project

summary
Get entity group membership

Parameters
- builder: RequestBuilder
- params: {count?: number; member: string; pageToken?: string; realm: string}
 - Optional count?: number
 - member: string
 - Optional pageToken?: string
 - realm: string
Returns Promise<GroupPageWToken>

getEntityManagedGroups

getEntityManagedGroups(builder: RequestBuilder, params: {count?: number; member: string; pageToken?: string; realm: string}): Promise<GroupPageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:981
Retrieve the list of groups over which the provided entity has been granted the role of GroupAdmin. Restrictions:
- The calling principal must have permission to take the readGroups action against the specified entity.
example:
In order to retrieve the groups a user, HERE-4ba9aca3-fdf9-4cad-a3da-534494d6198f, is an admin of, a permission with the following would be required:
- "action" : "readGroups"
- "resource" : "hrn:here:account::myrealm:user/HERE-4ba9aca3-fdf9-4cad-a3da-534494d6198f"
- This API works only with tokens that are not scoped to a project.
summary
Get entity managed group
Parameters
- builder: RequestBuilder
- params: {count?: number; member: string; pageToken?: string; realm: string}
 - Optional count?: number
 - member: string
 - Optional pageToken?: string
 - realm: string
Returns Promise<GroupPageWToken>

getGrant

getGrant(builder: RequestBuilder, params: {actionId: string; entityId: string; entityType: string; resourceHrn: string}): Promise<EntityGrant>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1340
Get a single grant given to an entity. This calls returns any permission to take the specified action against the specified resource on the requested entity. Restrictions:
- The realm of the calling principal must match the realm of the requested app.
- The calling principal must have permission to take the listGrants OR share action against the specified resource.
- In order to get a grant against resource hrn:here:data:::my-shared-catalog a permission with the following would be required:
- "action" : "listGrants"
- "resource" : "hrn:here:data:::my-shared-catalog" OR
- "action" : "share"
- "resource" : "hrn:here:data:::my-shared-catalog"
- This API works only with tokens that are not scoped to a project.
summary
Get a single grant given to an entity
Parameters
- builder: RequestBuilder
- params: {actionId: string; entityId: string; entityType: string; resourceHrn: string}
 - actionId: string
 - entityId: string
 - entityType: string
 - resourceHrn: string
Returns Promise<EntityGrant>

getGrants

getGrants(builder: RequestBuilder, params: {entityId: string; entityType: string; resourceHrn: string}): Promise<EntityGrant>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1386
Get grants. This call describes the permissions assigned to the specified entity that grant access to the specified resource.
Restrictions:
- The realm of the calling principal must match the realm of the requested entity.
- The calling principal must have permission to take the listGrants OR share action against the specified resource.
- Example: In order to get grants against resource hrn:here:data:::my-shared-catalog a permission with the following would be required:
- "action" : "listGrants"
- "resource" : "hrn:here:data:::my-shared-catalog" OR
- "action" : "share"
- "resource" : "hrn:here:data:::my-shared-catalog"
- This API works only with tokens that are not scoped to a project.
summary
Get grants given to a user, app, or group
Parameters
- builder: RequestBuilder
- params: {entityId: string; entityType: string; resourceHrn: string}
 - entityId: string
 - entityType: string
 - resourceHrn: string
Returns Promise<EntityGrant>

getGroup

getGroup(builder: RequestBuilder, params: {groupId: string}): Promise<Group>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1973
Retrieve the group identified by the provided group HRN.
Restrictions:
- The calling principal must have permission to take the readMembers action against the realm associated with the calling party.
- Example: In order to retrieve a group within the calling party's realm a permission with the following would be required:
- "action" : "readMembers"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Get single group
Parameters
- builder: RequestBuilder
- params: {groupId: string}
 - groupId: string
Returns Promise<Group>

getGroupMember

getGroupMember(builder: RequestBuilder, params: {groupId: string; member: string}): Promise<GroupMember>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2011
Retrieve a single group member.
Restrictions:
- The calling principal must have permission to take the readMembers action against the group identified by the provided group HRN.
- Example: In order to retrieve a single member of the group, GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a, a permission with the following would be required:
- "action" : "readMembers"
- "resource" : "hrn:here:authorization::myrealm:group/GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a"
- This API works only with tokens that are not scoped to a project.
summary
Get single Group member
Parameters
- builder: RequestBuilder
- params: {groupId: string; member: string}
 - groupId: string
 - member: string
Returns Promise<GroupMember>

getGroupMembers

getGroupMembers(builder: RequestBuilder, params: {count?: number; entityType?: string; groupId: string; pageToken?: string}): Promise<GroupMemberPageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2050
Retrieve the list of members of the group identified by the provided group HRN.
Restrictions:
- The calling principal must have permission to take the readMembers action against the group identified by the provided group HRN.
- Example: In order to retrieve the members of the group, GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a, a permission with the following would be required:
- "action" : "readMembers"
- "resource" : "hrn:here:authorization::myrealm:group/GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a"
- This API works only with tokens that are not scoped to a project.
summary
Get Group members
Parameters
- builder: RequestBuilder
- params: {count?: number; entityType?: string; groupId: string; pageToken?: string}
 - Optional count?: number
 - Optional entityType?: string
 - groupId: string
 - Optional pageToken?: string
Returns Promise<GroupMemberPageWToken>

getGroupRoles

getGroupRoles(builder: RequestBuilder, params: {count?: number; groupId: string; pageToken?: string}): Promise<RolePageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2094
List the roles which are associated with the provided group.
Restrictions:
- The calling principal must have permission to take the readRoles action against the specified group.
- Example: In order list the roles associated with the group, GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a, a permission with the following would be required:
- "action" : "readRoles"
- "resource" : "hrn:here:authorization::myrealm:group/GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a"
- This API works only with tokens that are not scoped to a project.
summary
Get group roles
Parameters
- builder: RequestBuilder
- params: {count?: number; groupId: string; pageToken?: string}
 - Optional count?: number
 - groupId: string
 - Optional pageToken?: string
Returns Promise<RolePageWToken>

getGroups

getGroups(builder: RequestBuilder, params?: {count?: number; pageToken?: string; q?: string}): Promise<GroupPageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2136
Retrieve the list of groups within the realm associated with the calling party.
Restrictions:
- The calling principal must have permission to take the readMembers action against the realm associated with the calling party.
- Example: In order to list the groups within the calling party's realm a permission with the following would be required:
- "action" : "readMembers"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Get groups
Parameters
- builder: RequestBuilder
- Optional params: {count?: number; pageToken?: string; q?: string}
 - Optional count?: number
 - Optional pageToken?: string
 - Optional q?: string
Returns Promise<GroupPageWToken>

getListOfWaysResourceIsLinkable

getListOfWaysResourceIsLinkable(builder: RequestBuilder, params: {limit?: number; pageToken?: string; resource: string; xCorrelationID?: string}): Promise<LinkableResourceList>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3080
Get a list of ways this resource has been made linkable
Access Control:
- The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
- Example: In order to make a catalog linkable, the following permission would be required:
- "action" : "manageResource"
- "resource" : "hrn:here:data::olp-here:my-shared-catalog"
This API works only with tokens that are scoped to the home project of the resource.
summary
Get a list of ways the resource has been made linkable
Parameters
- builder: RequestBuilder
- params: {limit?: number; pageToken?: string; resource: string; xCorrelationID?: string}
 - Optional limit?: number
 - Optional pageToken?: string
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<LinkableResourceList>

getMyGroups

getMyGroups(builder: RequestBuilder, params?: {count?: number; pageToken?: string}): Promise<GroupPageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2167

Retrieve a list of groups of a member

This API works only with tokens that are not scoped to a project.

summary
Get My Groups

Parameters
- builder: RequestBuilder
- Optional params: {count?: number; pageToken?: string}
 - Optional count?: number
 - Optional pageToken?: string
Returns Promise<GroupPageWToken>

getMyRoles

getMyRoles(builder: RequestBuilder, params?: {count?: number; pageToken?: string}): Promise<RolePageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1587

Retrieve the list of roles which have been assigned to the calling party. This API works only with tokens that are not scoped to a project.

summary
Get My Roles

Parameters
- builder: RequestBuilder
- Optional params: {count?: number; pageToken?: string}
 - Optional count?: number
 - Optional pageToken?: string
Returns Promise<RolePageWToken>

getProject

getProject(builder: RequestBuilder, params: {project: string; xCorrelationID?: string}): Promise<ProjectResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2694
Get the requested Project
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to get a project, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Get the requested Project
Parameters
- builder: RequestBuilder
- params: {project: string; xCorrelationID?: string}
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectResponse>

getProjectList

getProjectList(builder: RequestBuilder, params: {canManage?: boolean; isMember?: boolean; limit?: number; pageToken?: string; xCorrelationID?: string}): Promise<ProjectListWithPageToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2734
Get the list of Projects you are a project admin or a member based on the "canManage" or "isMember" parameter's value.

note
If neither "canManage" nor "isMember" is specified, "isMember=true" projects are returned. Supported values for "canManage" / "isMember" is : [true]

Access Control:
- User Access Token & Client Access Token
- This API works only with tokens that are not scoped to a project.
summary
Get the list of Projects that you are a project admin or a member based on the "canManage" or "isMember" parameter's value
Parameters
- builder: RequestBuilder
- params: {canManage?: boolean; isMember?: boolean; limit?: number; pageToken?: string; xCorrelationID?: string}
 - Optional canManage?: boolean
 - Optional isMember?: boolean
 - Optional limit?: number
 - Optional pageToken?: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectListWithPageToken>

getProjectMember

getProjectMember(builder: RequestBuilder, params: {member: string; project: string; xCorrelationID?: string}): Promise<ProjectMember>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2780
Get the requested Project Member
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to get a member of a Project, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Get the requested Project Member
Parameters
- builder: RequestBuilder
- params: {member: string; project: string; xCorrelationID?: string}
 - member: string
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectMember>

getProjectPolicy

getProjectPolicy(builder: RequestBuilder, params: {policy: string; project: string}): Promise<ProjectPolicyResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3883
Get the requested Project Policy
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to read a project policy, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins
- This API works only with tokens that are not scoped to a project.
summary
Get the Project Policy
Parameters
- builder: RequestBuilder
- params: {policy: string; project: string}
 - policy: string
 - project: string
Returns Promise<ProjectPolicyResponse>

getProjectPolicyList

getProjectPolicyList(builder: RequestBuilder, params: {limit?: number; pageToken?: string; project: string; projectPolicyType?: string; xCorrelationID?: string}): Promise<ProjectPolicyListResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3925
List the Policies that can be attached to members of the Project. This list will contain all the HERE provided policies and any custom user defined policies created in the Project.
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to read a policy list of a Project, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Members, Project Admins, Org Admins
- This API works only with tokens that are not scoped to a project.
summary
List the Policies in a Project
Parameters
- builder: RequestBuilder
- params: {limit?: number; pageToken?: string; project: string; projectPolicyType?: string; xCorrelationID?: string}
 - Optional limit?: number
 - Optional pageToken?: string
 - project: string
 - Optional projectPolicyType?: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectPolicyListResponse>

getProjectResource

getProjectResource(builder: RequestBuilder, params: {project: string; relation?: "home" | "reference"; resource: string; xCorrelationID?: string}): Promise<ResourceInProjectResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2824
Get the resource that is linked to the requested Project.
The requested resource may be linked as either a home or a reference(link).

Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified project
- Example: In order to get resource "hrn:here:data::myrealm:my-catalog-0000" in the project "hrn:here:authorization::myrealm:project/my-project-0000", the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Get a resource that is linked to a Project as either a Resource Home or Resource Reference(Link)
Parameters
- builder: RequestBuilder
- params: {project: string; relation?: "home" | "reference"; resource: string; xCorrelationID?: string}
 - project: string
 - Optional relation?: "home" | "reference"
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<ResourceInProjectResponse>

getRealmMember

getRealmMember(builder: RequestBuilder, params: {member: string; realm: string}): Promise<RealmMember>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1021
Retrieve the user or application details of the member defined by memberId. Restrictions:
- The calling principal must have permission to take the readMembers action against the specified realm.
example:
In order to retrieve a member of the realm, MyRealm, a permission with the following would be required:
- "action" : "readMembers"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Get realm member
Parameters
- builder: RequestBuilder
- params: {member: string; realm: string}
 - member: string
 - realm: string
Returns Promise<RealmMember>

getRealmMembers

getRealmMembers(builder: RequestBuilder, params: {count?: number; entityType?: string; pageToken?: string; q?: string; realm: string; state?: string}): Promise<RealmMemberPageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1068
Retrieve the list of members within the realm. Restrictions:
- The calling principal must have permission to take the readMembers action against the specified realm.
example:
In order to list the members of the realm, MyRealm, a permission with the following would be required:
- "action" : "readMembers"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Get realm members
Parameters
- builder: RequestBuilder
- params: {count?: number; entityType?: string; pageToken?: string; q?: string; realm: string; state?: string}
 - Optional count?: number
 - Optional entityType?: string
 - Optional pageToken?: string
 - Optional q?: string
 - realm: string
 - Optional state?: string
Returns Promise<RealmMemberPageWToken>

getResource

getResource(builder: RequestBuilder, params: {referenceable: boolean; resource: string; xCorrelationID?: string}): Promise<ResourceResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3123

Get the Resource that the caller is allowed to see based on the input query parameters

This API works only with tokens that are not scoped to a project.

summary
Get a single resource

Parameters
- builder: RequestBuilder
- params: {referenceable: boolean; resource: string; xCorrelationID?: string}
 - referenceable: boolean
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<ResourceResponse>

getResourceActionsForProject

getResourceActionsForProject(builder: RequestBuilder, params: {project: string; resource: string; type: string; xCorrelationID?: string}): Promise<string[]>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:4072
Gets the actions list for the resource for the project based on the query parameters.
The list of available actions are filtered based on the relation of the resource, either home or reference with the allowed actions. This API provides a list of available actions during project workflows like linking or project policy creation.

Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified project
- Example: In order to get resource "hrn:here:data::myrealm:my-catalog-0000" in the project "hrn:here:authorization::myrealm:project/my-project-0000", the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Get a list of actions that are allowed for the project resource
Parameters
- builder: RequestBuilder
- params: {project: string; resource: string; type: string; xCorrelationID?: string}
 - project: string
 - resource: string
 - type: string
 - Optional xCorrelationID?: string
Returns Promise<string[]>

getResourceLinkability

getResourceLinkability(builder: RequestBuilder, params: {availableToHrn: string; resource: string; xCorrelationID?: string}): Promise<LinkableResource>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3170
Get the availability for linking this resource to either a project or realm.
Access Control:
- The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
- Example: In order to get the catalog linkability, the following permission would be required:
- "action" : "manageResource"
- "resource" : "hrn:here:data::olp-here:my-shared-catalog" This API works only with tokens that are scoped to the home project of the resource.
summary
Get the linkability of a resource
Parameters
- builder: RequestBuilder
- params: {availableToHrn: string; resource: string; xCorrelationID?: string}
 - availableToHrn: string
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<LinkableResource>

getResourceProjects

getResourceProjects(builder: RequestBuilder, params: {limit?: number; pageToken?: string; relation?: "home" | "reference"; resource: string; xCorrelationID?: string}): Promise<ResourceProjectListWithPageToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3228
Get the list of Projects that the resource belongs to or is referenced in(linked to). The returned list will only include projects that are in the caller's realm.

note
If the presented access token has a project scope, the response will include:
- The home project of the resource
- The list of Projects that the resource has been made linkable to
- The include the list of Projects that the resource has been linked to
If the presented access token has no scope, the response will include:
- The list of Projects filtered out based on the membership of the caller.
Access Control for project scoped call:
- The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
- Example: In order to make a catalog linkable, the following permission would be required:
- "action" : "manageResource"
- "resource" : "hrn:here:data::olp-here:my-shared-catalog"
summary
Get the requested Projects that the resource belongs to or is referenced in(linked to)
Parameters
- builder: RequestBuilder
- params: {limit?: number; pageToken?: string; relation?: "home" | "reference"; resource: string; xCorrelationID?: string}
 - Optional limit?: number
 - Optional pageToken?: string
 - Optional relation?: "home" | "reference"
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<ResourceProjectListWithPageToken>

getResourceTypeActionList

getResourceTypeActionList(builder: RequestBuilder, params: {resourceType: <a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-authorizationapi#Type" class="typedoc-tsd-signature-type" data-tsd-kind="Type alias">Type</a>; type: string; xCorrelationID?: string}): Promise<string[]>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:4112

Gets the actions list for the resource type based on the query parameters.

summary
Get a list of actions for the resource type

Parameters
- builder: RequestBuilder
- params: {resourceType: <a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-authorizationapi#Type" class="typedoc-tsd-signature-type" data-tsd-kind="Type alias">Type</a>; type: string; xCorrelationID?: string}
 - resourceType: Type
 - type: string
 - Optional xCorrelationID?: string
Returns Promise<string[]>

getResources

getResources(builder: RequestBuilder, params: {access?: string; limit?: number; linkable?: boolean; pageToken?: string; referenceable?: boolean; type: <a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-authorizationapi#Type" class="typedoc-tsd-signature-type" data-tsd-kind="Type alias">Type</a>; xCorrelationID?: string}): Promise<ResourceListDetailedWithPageToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3309
Get a list of Resources that the caller is allowed to see based on the input query parameters.

note
If the presented access token has a project scope:
- The response will only include resources from that project or,
- If referenceable=true or linkable=true, the response will include the resources that are available to the caller to link to the project in the token's project scope.
- If the presented access token has no scope:
- The response will include resources from all projects that the caller has access to.
- For type='catalog' the response will also include resources that exist outside of any project.
- For all other types, the response will NOT include resources that exist outside of any project.
- For referenceable=true or linkable=true, the response will ONLY include the HERE public resources that are available to the caller to link to ANY project * This API works with tokens that are scoped and not scoped to a project.
summary
Get a list of resources
Parameters
- builder: RequestBuilder
- params: {access?: string; limit?: number; linkable?: boolean; pageToken?: string; referenceable?: boolean; type: <a href="sdk-for-typescript-modules-olp_sdk_dataservice_api-authorizationapi#Type" class="typedoc-tsd-signature-type" data-tsd-kind="Type alias">Type</a>; xCorrelationID?: string}
 - Optional access?: string
 - Optional limit?: number
 - Optional linkable?: boolean
 - Optional pageToken?: string
 - Optional referenceable?: boolean
 - type: Type
 - Optional xCorrelationID?: string
Returns Promise<ResourceListDetailedWithPageToken>

getRole

getRole(builder: RequestBuilder, params: {role: string}): Promise<Role>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1624
Get the role identified by the provided Role HRN.
Restrictions:
- The calling principal must have permission to take the readRoles action against the specified realm.
Example: In order to retrieve a role within the realm, MyRealm, a permission with the following would be required:
- "action" : "readRoles"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Get Role
Parameters
- builder: RequestBuilder
- params: {role: string}
 - role: string
Returns Promise<Role>

getRoleEntities

getRoleEntities(builder: RequestBuilder, params: {count?: number; pageToken?: string; role: string}): Promise<RoleEntityPageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1663
Retrieve the list of entities which have been assigned the role as identified by the provided role HRN.
Restrictions:
- The calling principal must have permission to take the readEntities action against the specified role.
Example: In order to list the entities assigned the role, _ hrn:here:authorization::myrealm:role/ROLE-c1662138-a170-4264-ba18-7b506a708c37_, a permission with the following would be required:
- "action" : "readEntities"
- "resource" : "hrn:here:authorization::myrealm:role/ROLE-c1662138-a170-4264-ba18-7b506a708c37"
- This API works only with tokens that are not scoped to a project.
summary
Get role entities
Parameters
- builder: RequestBuilder
- params: {count?: number; pageToken?: string; role: string}
 - Optional count?: number
 - Optional pageToken?: string
 - role: string
Returns Promise<RoleEntityPageWToken>

getRoleEntity

getRoleEntity(builder: RequestBuilder, params: {entity: string; role: string}): Promise<RoleEntity>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1700
Retrieve a single entity which has been assigned the role as identified by the provided role HRN.
Restrictions:
- The calling principal must have permission to take the readEntities action against the specified role.
- Example: In order to retrieve an entity assigned the role, GroupAdmin, a permission with the following would be required:
- "action" : "readEntities"
- "resource" : "hrn:here:authorization::myrealm:role/ROLE-c1662138-a170-4264-ba18-7b506a708c37"
- This API works only with tokens that are not scoped to a project.
summary
Get a single role entity
Parameters
- builder: RequestBuilder
- params: {entity: string; role: string}
 - entity: string
 - role: string
Returns Promise<RoleEntity>

getRolePermission

getRolePermission(builder: RequestBuilder, params: {permission: string; role: string}): Promise<ActivePermission>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1734
Get a single permission associated with the role identified by the provided Role HRN.
Restrictions:
- The calling principal must have permission to take the readPermissions action against the specified role.
- Example: In order to retrieve a single role permission for the specified role in realm MyRealm, a permission with the following would be required:
- "action" : "readPermissions"
- "resource" : "hrn:here:authorization::myrealm:role/ROLE-c1662138-a170-4264-ba18-7b506a708c37"
- This API works only with tokens that are not scoped to a project.
summary
Get Role Permission
Parameters
- builder: RequestBuilder
- params: {permission: string; role: string}
 - permission: string
 - role: string
Returns Promise<ActivePermission>

getRolePermissions

getRolePermissions(builder: RequestBuilder, params: {count?: number; pageToken?: string; role: string}): Promise<PermissionPageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1771
Get the permissions associated with the role identified by the provided Role HRN.
Restrictions:
- The calling principal must have permission to take the readPermissions action against the specified role.
Example: In order to list role permissions for the specified role in realm MyRealm, a permission with the following would be required:
- "action" : "readPermissions"
- "resource" : "hrn:here:authorization::myrealm:role/ROLE-c1662138-a170-4264-ba18-7b506a708c37"
- This API works only with tokens that are not scoped to a project.
summary
Get Role Permissions
Parameters
- builder: RequestBuilder
- params: {count?: number; pageToken?: string; role: string}
 - Optional count?: number
 - Optional pageToken?: string
 - role: string
Returns Promise<PermissionPageWToken>

getRoles

getRoles(builder: RequestBuilder, params?: {count?: number; pageToken?: string; resource?: string; roleName?: string}): Promise<RolePageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1810
Retrieve the list of roles within the context of the provided realm.
Restrictions:
- The calling principal must have permission to take the readRoles action against the specified realm.
- Example: In order to list roles within the realm, MyRealm, a permission with the following would be required:
- "action" : "readRoles"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Get Roles
Parameters
- builder: RequestBuilder
- Optional params: {count?: number; pageToken?: string; resource?: string; roleName?: string}
 - Optional count?: number
 - Optional pageToken?: string
 - Optional resource?: string
 - Optional roleName?: string
Returns Promise<RolePageWToken>

leaveGroup

leaveGroup(builder: RequestBuilder, params: {groupId: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2195

Remove the calling party from the group. This operation will also remove administrative roles from this member. This API works only with tokens that are not scoped to a project.

summary
Removes the calling party from a group

Parameters
- builder: RequestBuilder
- params: {groupId: string}
 - groupId: string
Returns Promise<Response>

leaveProject

leaveProject(builder: RequestBuilder, params: {project: string; xCorrelationID?: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2864
Remove the caller from the specified Project
Access Control:
- User Access Token & Client Access Token
- Authorization : None
- This API works only with tokens that are not scoped to a project.
summary
Remove the caller from the specified Project
Parameters
- builder: RequestBuilder
- params: {project: string; xCorrelationID?: string}
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<Response>

listGrants

listGrants(builder: RequestBuilder, params: {count?: number; entityType?: string; pageToken?: string; resourceHrn: string}): Promise<EntityGrants>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1428
List grants on user, apps, or groups. This call describes the permissions assigned to any user, app, or group in the same realm as the calling principal that has been granted access to the specified resource through an exact matching permission. Permissions granted through policies and roles are not included. Restrictions:
- The calling principal must have permission to take the listGrants OR share action against the specified resource.
- Example: In order to list grants against resource hrn:here:data:::my-shared-catalog a permission with the following would be required:
- "action" : "listGrants"
- "resource" : "hrn:here:data:::my-shared-catalog" OR
- "action" : "share"
- "resource" : "hrn:here:data:::my-shared-catalog"
- This API works only with tokens that are not scoped to a project.
summary
List grants on users, apps, or groups
Parameters
- builder: RequestBuilder
- params: {count?: number; entityType?: string; pageToken?: string; resourceHrn: string}
 - Optional count?: number
 - Optional entityType?: string
 - Optional pageToken?: string
 - resourceHrn: string
Returns Promise<EntityGrants>

listProjectMembers

listProjectMembers(builder: RequestBuilder, params: {limit?: number; onlyIncludeIdentities?: boolean; pageToken?: string; project: string; xCorrelationID?: string}): Promise<ProjectMemberListWithPageToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2915
Get the list of members of the Project
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to get a list of project members, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
- if 'onlyIncludeIdentities' query parameter is set to true, 'total' is NOT returned in Response
summary
Get the list of members of the Project
Parameters
- builder: RequestBuilder
- params: {limit?: number; onlyIncludeIdentities?: boolean; pageToken?: string; project: string; xCorrelationID?: string}
 - Optional limit?: number
 - Optional onlyIncludeIdentities?: boolean
 - Optional pageToken?: string
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectMemberListWithPageToken>

listProjectResources

listProjectResources(builder: RequestBuilder, params: {limit?: number; pageToken?: string; project: string; relation?: "home" | "reference"; type?: "artifact" | "catalog" | "pipeline" | "pipeline-template" | "schema" | "flow" | "flow-pattern"; xCorrelationID?: string}): Promise<ResourceInProjectListWithPageToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2971
Get the list of resources in the requested Project & referenced in(linked to) the Project
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the read action for the specified resource.
- Example: In order to get the list of resources in the Project, the following permission would be required:
- "action" : "read"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Get the list of resources in the requested Project & referenced in(linked to) the Project
Parameters
- builder: RequestBuilder
- params: {limit?: number; pageToken?: string; project: string; relation?: "home" | "reference"; type?: "artifact" | "catalog" | "pipeline" | "pipeline-template" | "schema" | "flow" | "flow-pattern"; xCorrelationID?: string}
 - Optional limit?: number
 - Optional pageToken?: string
 - project: string
 - Optional relation?: "home" | "reference"
 - Optional type?: "artifact" | "catalog" | "pipeline" | "pipeline-template" | "schema" | "flow" | "flow-pattern"
 - Optional xCorrelationID?: string
Returns Promise<ResourceInProjectListWithPageToken>

listRealmResources

listRealmResources(builder: RequestBuilder, params: {limit?: number; pageToken?: string; type?: "artifact" | "catalog" | "pipeline" | "pipeline-template" | "schema" | "flow" | "flow-pattern"; xCorrelationID?: string}): Promise<ResourceListWithPageToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3366
Get List of all the resources in the realm of the caller
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the listRealmResources action for the specified resource.
- Example: In order to get a list of projects, the following permission would be required:
- "action" : "listRealmResources"
This API works only with tokens that are scoped to a project.
summary
Get List of all the resources in the realm of the caller
Parameters
- builder: RequestBuilder
- params: {limit?: number; pageToken?: string; type?: "artifact" | "catalog" | "pipeline" | "pipeline-template" | "schema" | "flow" | "flow-pattern"; xCorrelationID?: string}
 - Optional limit?: number
 - Optional pageToken?: string
 - Optional type?: "artifact" | "catalog" | "pipeline" | "pipeline-template" | "schema" | "flow" | "flow-pattern"
 - Optional xCorrelationID?: string
Returns Promise<ResourceListWithPageToken>

makeResourceLinkable

makeResourceLinkable(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-linkableresource" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">LinkableResource</a>; resource: string; xCorrelationID?: string}): Promise<LinkableResource>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3417
Adds a listing to make this resource linkable to either a project or entire realm.
The resource must belong to a project to be made linkable. Either projectHrn or realmHrn must be provided to make the resource linkable to.

Access Control:
- The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
- Example: In order to make a catalog linkable, the following permission would be required:
- "action" : "manageResource"
- "resource" : "hrn:here:data::olp-here:my-shared-catalog"
This API works only with tokens that are scoped to the home project of the resource.
summary
Make a resource Linkable
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-linkableresource" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">LinkableResource</a>; resource: string; xCorrelationID?: string}
 - body: LinkableResource
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<LinkableResource>

patchProject

patchProject(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-patchproject" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">PatchProject</a>; project: string; xCorrelationID?: string}): Promise<ProjectResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3026
Update the specified Project
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the write action for the specified resource.
- Example: In order to update a Project, the following permission would be required:
- "action" : "write"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- This API works only with tokens that are not scoped to a project.
summary
Update the specified Project
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-patchproject" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">PatchProject</a>; project: string; xCorrelationID?: string}
 - body: PatchProject
 - project: string
 - Optional xCorrelationID?: string
Returns Promise<ProjectResponse>

removeGrant

removeGrant(builder: RequestBuilder, params: {actionId: string; entityId: string; entityType: string; resourceHrn: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1481
Revoke access to a resource from an entity. The result of this call is that the specified entity will have any directly assigned permission to take the specified action against the specified resource removed.
Restrictions:
- The realm of the calling principal must match the realm of the requested app.
- The calling principal must have permission to take the removeGrant:{actionId} OR share action against the specified resource.
- Example: In order to remove a grant for the readResource action against resource hrn:here:data:::my-shared-catalog a permission with the following would be required:
- "action" : "removeGrant:readResource"
- "resource" : "hrn:here:data:::my-shared-catalog" OR
- "action" : "share"
- "resource" : "hrn:here:data:::my-shared-catalog"
- This API works only with tokens that are not scoped to a project.
summary
Revoke access to a resource from an entity
Parameters
- builder: RequestBuilder
- params: {actionId: string; entityId: string; entityType: string; resourceHrn: string}
 - actionId: string
 - entityId: string
 - entityType: string
 - resourceHrn: string
Returns Promise<Response>

removeGroupMember

removeGroupMember(builder: RequestBuilder, params: {groupId: string; member: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2233
Remove a member from the group. This operation will also remove administrative roles from this member.
Restrictions:
- The calling principal must have permission to take the manageMembers action against the group identified by the provided group HRN.
- Example: In order to remove a member from the group, GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a, a permission with the following would be required:
- "action" : "manageMembers"
- "resource" : "hrn:here:authorization::myrealm:group/GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a"
- This API works only with tokens that are not scoped to a project.
summary
Remove a member from the group.
Parameters
- builder: RequestBuilder
- params: {groupId: string; member: string}
 - groupId: string
 - member: string
Returns Promise<Response>

removeResourceLinkability

removeResourceLinkability(builder: RequestBuilder, params: {availableToHrn: string; resource: string; xCorrelationID?: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3469
Remove the linkability of this resource against the requested project or realm.

note
This action does not have any impact on pre-existing links.

Access Control:
- The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
- Example: In order to remove the catalog linkability, the following permission would be required:
- "action" : "manageResource"
- "resource" : "hrn:here:data::olp-here:my-shared-catalog"
This API works only with tokens that are scoped to the home project of the resource.

summary
Remove the linkability of a resource
Parameters
- builder: RequestBuilder
- params: {availableToHrn: string; resource: string; xCorrelationID?: string}
 - availableToHrn: string
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<Response>

resendRealmMemberInvite

resendRealmMemberInvite(builder: RequestBuilder, params: {invite: string; realm: string}): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1196
Resend an invitation to a new member to the realm. Restrictions:
- The calling principal must have permission to take the manageInvites action against the specified realm.
example:
In order to resend an invite to a new user to the realm, MyRealm, a permission with the following would be required:
- "action" : "manageInvites"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Resend an invitation to a user in a realm
Parameters
- builder: RequestBuilder
- params: {invite: string; realm: string}
 - invite: string
 - realm: string
Returns Promise<Response>

searchRealmMemberInvites

searchRealmMemberInvites(builder: RequestBuilder, params: {count?: number; group?: string; pageToken?: string; q?: string; realm: string}): Promise<InvitePageWToken>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:1236
Search for invitations in the realm, optionally providing a group. Restrictions:
- The calling principal must have permission to take the manageInvites action against the realm associated with the calling party.
example:
In order to list the invitations within the calling party's realm a permission with the following would be required:
- "action" : "manageInvites"
- "resource" : "hrn:here:account::myrealm:realm/myrealm"
- This API works only with tokens that are not scoped to a project.
summary
Search for invitations in a realm
Parameters
- builder: RequestBuilder
- params: {count?: number; group?: string; pageToken?: string; q?: string; realm: string}
 - Optional count?: number
 - Optional group?: string
 - Optional pageToken?: string
 - Optional q?: string
 - realm: string
Returns Promise<InvitePageWToken>

setAttachedProjectPoliciesToMember

setAttachedProjectPoliciesToMember(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-attachedpolicy" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">AttachedPolicy</a>[]; member: string; project: string}): Promise<AttachedPolicy[]>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3979
Sets the Attached Policies list for the specified Project Member, overwriting any pre-existing Attached Policies. The request body will replace any pre-existing Policy attachment(s), and replace that list with those Policies identified in the request body.
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the manageMembers action for the specified resource.
- Example: In order to attach a custom policy in a Project to a member, the following permissions would be required:
- "action" : "manageMembers"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000" AND * "action" : "managePolicies"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Admins and Resource Managers
- This API works only with tokens that are not scoped to a project.
summary
Set Attached Policies for Member
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-attachedpolicy" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">AttachedPolicy</a>[]; member: string; project: string}
 - body: AttachedPolicy[]
 - member: string
 - project: string
Returns Promise<AttachedPolicy[]>

updateGroup

updateGroup(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-group" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">Group</a>; groupId: string}): Promise<Group>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:2270
Update the group identified by the provided group HRN by updating all writable group fields including name and description.
Restrictions:
- The calling principal must have permission to take the updateGroup action against the group identified by the provided group HRN.
- Example: In order to modify the group, GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a, a permission with the following would be required:
- "action" : "updateGroup"
- "resource" : "hrn:here:authorization::myrealm:group/GROUP-8e270653-f592-45a8-88d7-46d409ccfa8a"
- This API works only with tokens that are not scoped to a project.
summary
Update group
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-group" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">Group</a>; groupId: string}
 - body: Group
 - groupId: string
Returns Promise<Group>

updateProjectPolicy

updateProjectPolicy(builder: RequestBuilder, params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-projectpolicyrequestbody" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ProjectPolicyRequestBody</a>; policy: string; project: string}): Promise<ProjectPolicyResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:4022
Update the requested custom policy in the Project
Access Control:
- User Access Token & Client Access Token
- The calling principal must have permission to take the managePolicies action for the specified resource.
- Example: In order to update a custom policy in a Project, the following permission would be required:
- "action" : "managePolicies"
- "resource" : "hrn:here:authorization::myrealm:project/my-project-0000"
- In the Project workflow, the above permission is granted to all Project Admins and Resource Managers
- This API works only with tokens that are not scoped to a project.
summary
Update the requested Project Policy
Parameters
- builder: RequestBuilder
- params: {body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-projectpolicyrequestbody" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">ProjectPolicyRequestBody</a>; policy: string; project: string}
 - body: ProjectPolicyRequestBody
 - policy: string
 - project: string
Returns Promise<ProjectPolicyResponse>

updateResourceLinkability

updateResourceLinkability(builder: RequestBuilder, params: {availableToHrn: string; body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-linkableresource" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">LinkableResource</a>; resource: string; xCorrelationID?: string}): Promise<LinkableResource>

- Defined in @here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts:3519
Update the linkability of this resource against the requested project or realm.
Access Control: * The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
- Example: In order to update the catalog linkability, the following permission would be required:
- "action" : "manageResource"
- "resource" : "hrn:here:data::olp-here:my-shared-catalog"
This API works only with tokens that are scoped to the home project of the resource.
summary
Update the linkability of a resource
Parameters
- builder: RequestBuilder
- params: {availableToHrn: string; body: <a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-linkableresource" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">LinkableResource</a>; resource: string; xCorrelationID?: string}
 - availableToHrn: string
 - body: LinkableResource
 - resource: string
 - Optional xCorrelationID?: string
Returns Promise<LinkableResource>

Index

Interfaces

Type Aliases

Functions

Type Aliases

EffectEnum

EntityTypeEnum

IdentityTypeEnum

Relation

ResourceRelation

StateEnum

Type

Functions

addGrant

Parameters

builder: RequestBuilder

actionId: string

entityId: string

entityType: string

resourceHrn: string

Returns Promise<EntityGrant>

addGroupMember

Parameters

builder: RequestBuilder

groupId: string

member: string

Returns Promise<Response>

addProjectMember

Parameters

builder: RequestBuilder

member: string

project: string

Optional xCorrelationID?: string

Returns Promise<Response>

addProjectResourceRelation

Parameters

builder: RequestBuilder

body: ResourceLinkActionBody

project: string

relation: ResourceRelation

resource: string

type: Type

Optional xCorrelationID?: string

Returns Promise<ResourceRelationResponse>

addRoleEntity

Parameters

builder: RequestBuilder

entity: string

role: string

Returns Promise<Response>

attachProjectPolicyToMember

Parameters

builder: RequestBuilder

member: string

policy: string

project: string

Returns Promise<Response>

cancelRealmMemberInvite

Parameters

builder: RequestBuilder

invite: string

realm: string

Returns Promise<Response>

checkProjectExistance

Parameters

builder: RequestBuilder

project: string

Optional xCorrelationID?: string

Returns Promise<Response>

createGroup

Parameters

builder: RequestBuilder

params: {</span>body<span class="typedoc-tsd-signature-symbol">: </span><a href="sdk-for-typescript-interfaces-olp_sdk_dataservice_api-authorizationapi-group" class="typedoc-tsd-signature-type" data-tsd-kind="Interface">Group</a><span class="typedoc-tsd-signature-symbol">}

body: Group

Returns Promise<Group>

createProject

Parameters

builder: RequestBuilder

body: ProjectRequest

Optional xCorrelationID?: string