A more technical look at the details regarding Service Account management.
Last updated
Hierarchy
Service Accounts are designed to be flexible enough to accommodate most organizational structures. They can be given access to any number of projects or organizations as required, with a specific level of permission in each. The access rights hierarchy can be summarized in a few points.
A Service Account is created under a project which becomes its owner.
A Service Account can be a member of other projects and organizations.
The Service Account membership is assigned a role for that project or organization.
A role provides the member with permissions within the related project or organization.
Manage Service Accounts
When first creating a Service Account within a project, the Service Account will not be a member of any projects or organizations, including the owning project. In DT Studio, the “Role in current Project” option will show as “No access” and can be changed to give the Service Account access to the resources in this project.
In your project, navigate to the API Integrations -> Service Accounts page. Locate the Service Account you wish to remove, then click the Remove button.
Once the package is installed and authenticated as described in the Python API Reference, a Service Account can be deleted by calling the following resource method.
Using our Python API with Service Account credentials for authentication, the following example deletes the Service Account specified by its ID.
import disruptive as dt# Authenticate the package using Service Account credentials.dt.default_auth = dt.Auth.service_account( key_id='<SERVICE_ACCOUNT_KEY_ID>', secret='<SERVICE_ACCOUNT_SECRET>', email='<SERVICE_ACCOUNT_EMAIL>',)# Delete the specified Service Account.dt.ServiceAccount.delete_service_account( service_account_id='<SERVICE_ACCOUNT_ID>', project_id='<PROJECT_ID>',)
Members
A single Service Account can be a member of several projects and organizations. These members are unique and independent from each other, allowing for different roles to be assigned.
Manage Project Members
A User or Service Account must have the role of Project Admin or higher to manage members.
New Project Member
If you do not possess a Service Account with sufficient access rights, new Project members must be added by an existing Project Admin in DT Studio or through the APIs.
In your project, navigate to the Project Settings page. Here, using the email of the target Service Account, select a role and click Invite Member. This can be changed later.
A list of all available parameters can be found in our REST API Reference and a list of all roles and their permissions under the Roles subsection on this very page.
Example Usage
Using cURL with a Service Account for authentication, the following example grants the specified Service Account the role of Project Developer in the specified project.
Once the package is installed and authenticated as described in the Python API Reference, a new project member can be added by calling the following resource method.
Using our Python API with Service Account credentials for authentication, the following example grants the specified Service Account the role of Project Developer in a project.
import disruptive as dt# Authenticate the package using Service Account credentials.dt.default_auth = dt.Auth.service_account( key_id='<SERVICE_ACCOUNT_KEY_ID>', secret='<SERVICE_ACCOUNT_SECRET>', email='<SERVICE_ACCOUNT_EMAIL>',)# Add a new project developer member to the specified project.member = dt.Project.add_member( project_id='<PROJECT_ID>', email='<SERVICE_ACCOUNT_EMAIL>', roles=[dt.Role.PROJECT_DEVELOPER],)# Print information about the newly created member.print(member)
Remove Project Member
In your project, navigate to the Project Settings page. Locate the member you wish to remove, then click the Remove button. For reference, see the image under New Project Member.
Here, <MEMBER_ID> is either the ID of a Service Account or User.
Example Usage
Using cURL with a Service Account for authentication, the following example removes the specified Service Accounts membership in the specified project.
Once the package is installed and authenticated as described in the Python API Reference, a project member can be removed by calling the following resource method.
Using our Python API with Service Account credentials for authentication, the following example removes the specified Service Accounts membership in the specified project.
import disruptive as dt# Authenticate the package using Service Account credentials.dt.default_auth = dt.Auth.service_account( key_id='<SERVICE_ACCOUNT_KEY_ID>', secret='<SERVICE_ACCOUNT_SECRET>', email='<SERVICE_ACCOUNT_EMAIL>',)# Remove member from the specified project.dt.Project.remove_member( member_id='<MEMBER_ID>', project_id='<PROJECT_ID>',)
Manage Organization Members
A User or Service Account must have the role of Organization Admin or higher to manage members.
New Organization Member
If you do not possess a Service Account with sufficient access rights, new Organization members must be added by an existing Organization Admin in DT Studio or through the APIs.
In any project, navigate to the Administrators page. Currently, the only role available for an organization member is organization.admin, hence the naming conventions used in DT Studio. Using the email of the Service Account you wish to add, click Invite Administrator.
Note that an organization.admin will obtain the same permissions as a project.admin in every single project under the organization in question.
A list of all available parameters can be found in our REST API Reference. Currently, the only role availbale is organization.admin.
Example Usage
Using cURL with a Service Account for authentication, the following example grants the specified Service Account the role of Organization Admin in the specified organization.
Once the package is installed and authenticated as described in the Python API Reference, an organization member can be added by calling the following resource method.
Using our Python API with Service Account credentials for authentication, the following example grants the specified Service Account the role of Organization Admin.
import disruptive as dt# Authenticate the package using Service Account credentials.dt.default_auth = dt.Auth.service_account( key_id='<SERVICE_ACCOUNT_KEY_ID>', secret='<SERVICE_ACCOUNT_SECRET>', email='<SERVICE_ACCOUNT_EMAIL>',)# Add a new organization admin member to the organization.member = dt.Organization.add_member( organization_id='<ORGANIZATION_ID>', email='<SERVICE_ACCOUNT_EMAIL>', roles=[dt.Role.ORGANIZATION_ADMIN],)# Print information about the newly created member.print(member)
Remove Organization Member
In any project, navigate to the Administrators page. Locate the member you wish to remove, then click the Remove button. For reference, see the image under New Organization Member.
Here, <MEMBER_ID> is either the ID of a Service Account or User.
Example Usage
Using cURL with a Service Account for authentication, the following example removes the specified Service Accounts membership in the specified organization.
Once the package is installed and authenticated as described in the Python API Reference, an organization member can be removed by calling the following resource method.
Using our Python API with Service Account credentials for authentication, the following example removes the specified Service Accounts membership in the specified organization.
import disruptive as dt# Authenticate the package using Service Account credentials.dt.default_auth = dt.Auth.service_account( key_id='<SERVICE_ACCOUNT_KEY_ID>', secret='<SERVICE_ACCOUNT_SECRET>', email='<SERVICE_ACCOUNT_EMAIL>',)# Remove member from the specified organization.dt.Organization.remove_member( member_id='<MEMBER_ID>', organization_id='<ORGANIZATION_ID>',)
Roles
A role contains permissions that determines which actions a member is authorized to perform on a specific resource in DT Cloud. To make permissions available to members, you grant them the role that provides the desired set of permissions.
The following roles are available.
project.user
project.developer
project.admin
organization.admin
Managing Roles
Roles can be managed by users or Service Account Members with an assigned role of Project Administrator or Organization Administrator for projects and organization levels. The role of a member is managed in the same place where the member itself is managed. See the Members section for details on where this is located, or use our REST API endpoint for Membership and Access Control.
