Represents an access a user has to a group of applications. With this access, the user can work with transactions within those applications. An access can be one of two different types: PRIVATE or CORPORATE.
| Name | Description | Qualification | Schema |
|---|---|---|---|
| accessId | The identifier of the access. It must not be specified during creation as it is generated by the server, but is required when updating an access. | Required Read-only | string |
| corporateId | The identifier of the corporate role. Required if the access type is CORPORATE. Not allowed if the access type is PRIVATE. This cannot be changed after the access has been created. | Optional Read-only | string |
| corporateName | The name of the company for which the user acts when working with this access. Only applicable if the access type is CORPORATE. | Optional | string |
| corporateRoleName | The name of the corporate role the user acts in when working with this access. Only applicable if the access type is CORPORATE. | Optional | string |
| firstName | The first name of the user that this access belongs to. | Required | string |
| lastName | The last name of the user that this access belongs to. | Required | string |
| managed | Indicates if this access should be managed by the platform or not. If set to true, the access is activated by the platform on behalf of the user. A managed access is an access operated by the platform. For example, when an application requests the access to sign a transaction, the platform signs the transaction on behalf of the user. On the other hand, an access that is not managed is an access operated by the user directly. For example, when an application requests the access to sign a transaction, the user signs the transaction using a PDI client. This cannot be changed after the access has been created | Required Read-only | boolean |
| privateId | The ID of the personal identity that this access is linked to. This cannot be changed after the access has been created. | Required Read-only | string |
| state | The state of the access. It must not be specified during creation as it is set by the server. The state of an access can be changed via the 'Update access' API, but note that the state can only be changed from ACTIVE to DEACTIVATED or from DEACTIVATED to ACTIVE. INVITED: The access has been created but not yet activated by the user. It cannot be used until the user has activated it. ACTIVE: The access has been activated by the user and can be used. DEACTIVATED: The access has been disabled and cannot be used. | Required | enum (INVITED, ACTIVE, DEACTIVATED) |
| type | Specifies whether the user that the access is given to acts in their private role or in a corporate role. PRIVATE: The user acts as in their private role. CORPORATE: The user acts in a corporate role. This cannot be changed after the access has been created. | Required Read-only | enum (PRIVATE, CORPORATE) |