Repositories

Create Repository

Creates a new repository on the account.

post/v1/repositories

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/repositories
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: repository)

Request body

namestring required

Display name for the repository

accessType'UNRESTRICTED' | 'RESTRICTED'

Determines repository visibility. UNRESTRICTED repositories are visible to all users on the account, RESTRICTED are visible to specific authorized groups and individuals.

groupsinteger[]

Optional. Group Ids of groups whose members should have access to this repository. Only applicable to RESTRICTED repositories.

Example request

{
  "name": "Example Process Repository",
  "accessType": "UNRESTRICTED",
  "users": [
    {
      "userId": 1234567,
      "role": "REPOSITORY_OWNER"
    }
  ],
  "groups": [
    123456,
    789123
  ]
}

Response

Created. Returns the newly created repository.

repositoryIdstring

Unique identifier for a repository folder, prefixed with repo_

namestring

Display name of the repository

accessType'UNRESTRICTED' | 'RESTRICTED'

Determines repository visibility. UNRESTRICTED repositories are visible to all users on the account, RESTRICTED are visible to specific authorized groups and individuals.

createdstring date-time

The date and time the repository was created

Example response

{
  "repositoryId": "repo_1234321",
  "name": "My Business Process Repository",
  "accessType": "UNRESTRICTED",
  "created": "2022-11-11T21:48:35.293Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.