Arvados™ Docs
  1. Concepts
    1. API Reference
    2. API Authorization
    3. REST API syntax
    4. Common resource methods
    5. Common resource fields
  2. Permission and authentication
    1. users
    2. groups
    3. api_client_authorizations
    4. links
    5. computed_permissions
    6. authorized_keys
    7. user_agreements
    8. virtual_machines
  3. Data management
    1. WebDAV
    2. S3 API
    3. Keep-web URL patterns
    4. Projects and filter groups
    5. Metadata properties
    6. collections
    7. logs
    8. keep_services
  4. Container engine
    1. container_requests
    2. containers
    3. workflows
    4. cloud dispatcher

user_agreements

API endpoint base: https://pirca.arvadosapi.com/arvados/v1/user_agreements

Resource

This provides an API for inactive users to sign clickthrough agreements prior to being activated.

Methods

Required arguments are displayed in green.

list

List user agreements. This is a list of collections which contain HTML files with the text of the clickthrough agreement(s) which can be rendered by Workbench.

Argument Type Description Location Example

signatures

List user agreements that have already been signed. These are recorded as link objects of {"link_class": "signature", "name": "click"}.

Argument Type Description Location Example

sign

Sign a user agreement.

Argument Type Description Location Example
uuid string The UUID of the user agreement collection. path
Previous: authorized_keys Next: virtual_machines

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.