The LifeTime Services API provides you functionality to manage the infrastructure made available by OutSystems Platform.

Application Management Service

The OutSystems Platform API for getting information about applications managed by the infrastructure management console. To use this API you need to send an authentication argument with username/password, or use the AuthenticationService Web Service API to acquire a session token to send as argument.

This API is exposed as a Web Service, made available at:

Actions

Action

Description

Application_List(WebServiceSimpleAuthentication Record)

Returns a list of applications and their information, that are visible within the platform for the authenticated user.

ApplicationPermissionLevel_List(WebServiceSimpleAuthentication Record)

The list of permission levels that a user has over an application.

Application_SetTag(WebServiceSimpleAuthentication Record, EnvironmentApplicationTagList Record)

Sets a tag for each application in a given environment.

Structures

Action

Description

APIStatus

The status of invoking an Outsystems Platform API. This status contains an error code and human readable error messages.

ApplicationInfo

Application details and environment specific information where the application is running.

ApplicationPermissionLevel

The permissions an IT user has over an application, as configured in the infrastructure management console.

ApplicationTag

Defines an application tag.

EnvironmentApplicationInfo

Application information for a specific environment.

EnvironmentApplicationTagList

Defines a list of application tags in a specific environment.

WebServiceSimpleAuthentication

Represents the fields to authenticate a Outsystems Platform IT user. Specify a username/password combination to authenticate, or use the AuthenticationService Web Service API to acquire a session token.

Authentication Management Service

The OutSystems Platform API to acquire an authentication token to be used when invoking other Outsystems Platform APIs. After 5 minutes, the token expires.

This API is exposed as a Web Service, made available at:

Actions

Action

Description

Authentication_GetToken(Text, Text)

Returns an authentication token that is valid for 5 minutes.

Structures

Action

Description

APIStatus

The status of invoking an Outsystems Platform API. This status contains an error code and human readable error messages.

Database Connection Management Service

This API provides methods to create, change, and delete connections to external databases. It also allows managing users permissions.

Actions

Action

Description

DbConnection_Delete Deletes the database connection given by the name.
DbConnection_TestConnection Tests a database connection with the given parameters.
DbConnection_GrantUserAccess Grants a user with a permission level to use the database connection.
DbConnection_Get Returns the database connection.
DbConnection_GetUserAccess Returns the user permissions to use a database connection.
DbConnection_RevokeRoleAccess Revokes the role permissions to use the database connection.
DbConnection_Rename Renames an database connection. This may have impact on all running application that use this database connection.
DbConnection_GetRoleAccess Returns the role permissions to use a database connection.
DbConnection_Edit Updates the configuration of the database connection.
DbConnection_ListProviders The list of database providers that a user can associate to a database connection.
DbConnection_PermissionLevel_List Returns the list of permission levels.
DbConnection_ListAll Returns a list with all database connections.
DbConnection_Create Creates a new database connection.
DbConnection_GrantRoleAccess Grants a role with a permission level to use the database connection.
DbConnection_RevokeUserAccess Revokes the user permissions to use the database connection.

Structures

Action

Description

WebServiceSimpleAuthentication

Represents the fields to authenticate a Outsystems Platform IT user. Specify a username/password combination to authenticate, or use the AuthenticationService Web Service API to acquire a session token.

Environment Management Service

The OutSystems Platform API for getting information about the environments managed by the infrastructure management console. To use this API you need to send an authentication argument with username/password, or use the AuthenticationService Web Service API to acquire a session token to send as argument.

This API is exposed as a Web Service, made available at:

Actions

Action

Description

Environment_List(WebServiceSimpleAuthentication Record)

Returns a list of environments with their information, such as name, version of the OutSystems Platform, and Application Server.

EnvironmentPermissionLevel_List(WebServiceSimpleAuthentication Record)

The list of permission levels that a platform user has over an environment.

Structures

Action

Description

APIStatus

The status of invoking an Outsystems Platform API. This status contains an error code and human readable error messages.

EnvironmentInfo

An environment and its information.

EnvironmentPermissionLevel

Information about the permission level an IT user has for an environment.

WebServiceSimpleAuthentication

Represents the fields to authenticate a Outsystems Platform IT user. Specify a username/password combination to authenticate, or use the AuthenticationService Web Service API to acquire a session token.

Role Management Service

The OutSystems Platform API to manage IT roles: roles created in the infrastructure management console. The authenticated user needs to have 'Manage Infrastructure' permissions in OutSystems Platform to use this API. To use this API you need to send an authentication argument with username/password, or use the AuthenticationService Web Service API to acquire a session token to send as argument.

This API is exposed as a Web Service, made available at:

Actions

Action

Description

Role_ChangeName(WebServiceSimpleAuthentication Record, Text, Text)

Updates the name of a platform role.

Role_CreateOrUpdate(WebServiceSimpleAuthentication Record, Text, Boolean, Text)

Creates a new platform role or updates a platform role that already exists.

Role_Delete(WebServiceSimpleAuthentication Record, Text, Text)

Deletes a platform role that already exists. Since the platform requires IT users to have a single role, you need to specify a new role to grant to the users that are currently set with the role you want to delete.

Role_GetPermissions(WebServiceSimpleAuthentication Record, Text)

Returns the list of permissions a platform role has in the environments registered in the platform.

Role_List(WebServiceSimpleAuthentication Record)

Returns all platform roles, with their information.

Role_UpdatePermission(WebServiceSimpleAuthentication Record, Text, Text, EnvironmentPermissionLevel Identifier)

Updates the permissions a role has in a specified environment.

Structures

Action

Description

APIStatus

The status of invoking an Outsystems Platform API. This status contains an error code and human readable error messages.

EnvironmentPermissionForRole

Role information for a specific environment.

PlatformRole

Details about a role.

PlatformUser

The information about a user.

WebServiceSimpleAuthentication

Represents the fields to authenticate a Outsystems Platform IT user. Specify a username/password combination to authenticate, or use the AuthenticationService Web Service API to acquire a session token.

Team Management Service

The OutSystems Platform API to manage IT teams. It provides a set of actions that allows manipulating these platform teams, such as creating and updating them, assign users with specific roles in the team, or even assign applications that will be accessible to the teams members.

This API is exposed as a Web Service, made available at:

Actions

Action

Description

Team_AddUser(WebServiceSimpleAuthentication Record, Text, Text, Text)

Adds a user to a team with a specified role.

Team_AssignApplication(WebServiceSimpleAuthentication Record, Text, Text)

Assigns an application to a team, even if the application is already assigned to a team.

Team_CreateOrUpdate(WebServiceSimpleAuthentication Record, Text, Text)

Creates a new team or updates an already existent team.

Team_Delete(WebServiceSimpleAuthentication Record, Text)

Deletes a team.

Team_GetDetails(WebServiceSimpleAuthentication Record, Text)

Returns the details of a team, with its users and applications.

Team_List(WebServiceSimpleAuthentication Record)

Returns a list of the teams.

Team_RemoveApplication(WebServiceSimpleAuthentication Record, Text, Text)

Removes an application from a team.

Team_RemoveUser(WebServiceSimpleAuthentication Record, Text, Text)

Removes a user from a team.

Structures

Action

Description

APIStatus

The status of invoking an Outsystems Platform API. This status contains an error code and human readable error messages.

PlatformTeam

The information about a platform team.

WebServiceSimpleAuthentication

Represents the fields to authenticate a Outsystems Platform IT user. Specify a username/password combination to authenticate, or use the AuthenticationService Web Service API to acquire a session token.

User Management Service

The OutSystems Platform API to manage IT users: users created in the infrastructure management console. The authenticated user needs to have 'Manage Infrastructure' permissions in OutSystems Platform to use this API. To use this API you need to send an authentication argument with username/password, or use the AuthenticationService Web Service API to acquire a session token to send as argument.

This API is exposed as a Web Service, made available at:

Actions

Action

Description

User_ChangePassword(WebServiceSimpleAuthentication Record, Text, Text, Boolean)

Changes the password of a platform user.

User_ChangeUsername(WebServiceSimpleAuthentication Record, Text, Text)

Changes the username of a platform user.

User_CreateOrUpdate(WebServiceSimpleAuthentication Record, Text, Text, Boolean, Text, Email, Text)

Creates a new platform user or updates a user that already exists.

User_DeleteApplicationPermission(WebServiceSimpleAuthentication Record, Text, Text)

Deletes the permission a user has for a specific application. After executing this operation, the user permissions for the application are defined by the roles the user has.

User_GetAllPermissions(WebServiceSimpleAuthentication Record, Text)

Returns the permissions a user has over each existing application and the permissions of her role, in each environment of the infrastructure.

User_GetApplicationPermissions(WebServiceSimpleAuthentication Record, Text, Text)

Returns the permissions a user has over an application, in each environment of the infrastructure.

User_List(WebServiceSimpleAuthentication Record, Boolean)

Returns the list of platform users, with their information, such as username, email and role.

User_SetActive(WebServiceSimpleAuthentication Record, Text)

Activates a platform user, restoring all permissions the user has associated.

User_SetApplicationRole(WebServiceSimpleAuthentication Record, Text, Text, Text)

Sets or updates the role for a user in an application.

User_SetInactive(WebServiceSimpleAuthentication Record, Text)

Deactivates a platform user. The user stops having access to all operations that require authentication.

User_UpdateApplicationPermission(WebServiceSimpleAuthentication Record, Text, Text, Text, ApplicationPermissionLevel Identifier)

[DEPRECATED] Use User_SetApplicationRole. Updates the permission a user has for an application running on a given environment.

Structures

Action

Description

APIStatus

The status of invoking an Outsystems Platform API. This status contains an error code and human readable error messages.

ApplicationPermissions

Represents a set of permissions with respect to the environments.

ApplicationShortInfo

Few details about an application managed by LifeTime.

EnvironmentPermissionForApplication

Basic information about an environment such as its name, host, type and the corresponding permission.

PlatformUser

The information about a user.

WebServiceSimpleAuthentication

Represents the fields to authenticate a Outsystems Platform IT user. Specify a username/password combination to authenticate, or use the AuthenticationService Web Service API to acquire a session token.

See Also

About APIs