API docs by Redocly

Source Cooperative API (1.0.0)

Download OpenAPI specification:Download

API Keys

Create a new API key for an account.

Creates a new API key for the specified account. API key expiration date must be in the future. For user accounts, you must be authenticated as the user account you are creating the API key for. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization account you are creating the API key for. Only users with the admin flag may create API keys for service accounts.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to create the API key for

Request Body schema: application/json
required
name
required
string
expires
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "Dev Machine",
  • "expires": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "access_key_id": "SCFOOBAR",
  • "account_id": "account-id",
  • "repository_id": "repository-id",
  • "disabled": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "Dev Machine",
  • "secret_access_key": "stringstringstringstringstringstringstringstringstringstringstri"
}

List API keys for an account

Retrieves all API keys associated with the specified account. For user accounts, you must be authenticated as the user account you are listing API keys for. For organization accounts, you must be authenticated as either an owners or maintainers member of the organization account you are listing API keys for. Only users with the admin flag may list API keys for service accounts.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to list API keys for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Revoke an API key

Revokes (disables) the specified API key. For an API Key assigned to a User account, only the user who created the API key can revoke it. For an API Key assigned to an Organization, only organization members with owners or maintainers membership can revoke it. For an API Key assigned to a Repoisitory, only repository or organization members with owners or maintainers membership can revoke it. Users with the admin flag may disable any API Key.

Authorizations:
ApiKeyAuth
path Parameters
access_key_id
required
string

The access key ID of the API key to revoke

Responses

Response samples

Content type
application/json
{
  • "access_key_id": "SCFOOBAR",
  • "account_id": "account-id",
  • "repository_id": "repository-id",
  • "disabled": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "Dev Machine"
}

Create a new API key

Creates a new API key for the specified repository. Only users who are an owners or maintainers member of the repository or organization may create an API Key. Users with the admin flag may create API keys for any repository.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account

repository_id
required
string

The ID of the repository to create the API key for

Request Body schema: application/json
required
name
required
string
expires
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "Dev Machine",
  • "expires": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "access_key_id": "SCFOOBAR",
  • "account_id": "account-id",
  • "repository_id": "repository-id",
  • "disabled": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "Dev Machine",
  • "secret_access_key": "stringstringstringstringstringstringstringstringstringstringstri"
}

List API keys for a repository

Retrieves all API keys associated with the specified repository. Only users who are an owners or maintainers member of the repository or organization may list API keys. Users with the admin flag may list API keys for any repository.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account

repository_id
required
string

The ID of the repository to list API keys for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Accounts

Create a new API key for an account.

Creates a new API key for the specified account. API key expiration date must be in the future. For user accounts, you must be authenticated as the user account you are creating the API key for. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization account you are creating the API key for. Only users with the admin flag may create API keys for service accounts.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to create the API key for

Request Body schema: application/json
required
name
required
string
expires
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "Dev Machine",
  • "expires": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "access_key_id": "SCFOOBAR",
  • "account_id": "account-id",
  • "repository_id": "repository-id",
  • "disabled": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "Dev Machine",
  • "secret_access_key": "stringstringstringstringstringstringstringstringstringstringstri"
}

List API keys for an account

Retrieves all API keys associated with the specified account. For user accounts, you must be authenticated as the user account you are listing API keys for. For organization accounts, you must be authenticated as either an owners or maintainers member of the organization account you are listing API keys for. Only users with the admin flag may list API keys for service accounts.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to list API keys for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get account flags

Retrieves the flags of a specific account. For a User account, users may only get the flags for their own account. For an Organization account, only users who are owners or maintainers of the organization may get the flags. Users with the admin flag may get the flags for any account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account whose flags to retrieve

Responses

Response samples

Content type
application/json
[
  • "admin"
]

Update account flags

Updates the flags of a specific account. You must have the admin flag to update the flags for an account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account whose flags to update

Request Body schema: application/json
required
Array
string
Enum: "admin" "create_repositories" "create_organizations"

Responses

Request samples

Content type
application/json
[
  • "admin"
]

Response samples

Content type
application/json
[
  • "admin"
]

Get account details

Retrieves the details of a specific account. For a User account, you must be authenticated as the user you are retrieving the account details for. For an Organization account, you must be authenticated as either an owners or maintainers member of the organization you are retrieving the account details for. Users with the admin flag may retrieve the account details for any account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to retrieve

Responses

Response samples

Content type
application/json
{
  • "account_id": "account-id",
  • "account_type": "user",
  • "identity_id": "identity-id",
  • "disabled": true,
  • "profile": {
    },
  • "flags": [
    ]
}

Disable an account

Disables a specific account. User accounts may not be disabled unless you are authenticated as a user with the admin flag. Organization accounts require that you are authenticated as an owners or maintainers member of the organization.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to disable

Responses

Response samples

Content type
application/json
{
  • "account_id": "account-id",
  • "account_type": "user",
  • "identity_id": "identity-id",
  • "disabled": true,
  • "profile": {
    },
  • "flags": [
    ]
}

Invite a new member to an account.

Invites a new member to the specified account. For user accounts, you must be authenticated as the user account you are inviting the member to. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization account you are inviting the member to. Only users with the admin flag may invite members to service accounts.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to invite the member to

Request Body schema: application/json
required
account_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$
role
required
string (MembershipRole)
Enum: "owners" "maintainers" "read_data" "write_data"

Responses

Request samples

Content type
application/json
{
  • "account_id": "account-id",
  • "role": "owners"
}

Response samples

Content type
application/json
{
  • "membership_id": "00000000-0000-0000-0000-000000000000",
  • "account_id": "account-id",
  • "membership_account_id": "organization-id",
  • "repository_id": "repository-id",
  • "role": "owners",
  • "state": "invited",
  • "state_changed": "2019-08-24T14:15:22Z"
}

List the memberships for an account

Retrieves all memberships associated with the specified account. For user accounts, you must be authenticated as the user account you are listing memberships for. For organization accounts, you must be authenticated as either an owners or maintainers member of the organization account you are listing memberships for.

Only users with the admin flag may list memberships for service accounts.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to list memberships for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get account profile

Retrieves the profile of a specific account. Any user, authenticated or not, can retrieve the profile of any account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account whose profile to retrieve

Responses

Response samples

Content type
application/json
{
  • "name": "Isaac Asimov",
  • "bio": "Software Engineer @radiantearth",
  • "location": "Augsburg, Germany",
  • "url": "https://source.coop"
}

Update account profile

Updates the profile of a specific account. For a User account, you must be authenticated as the user you are updating the profile for. For an Organization account, you must be authenticated as an owners member of the organization you are updating the profile for. Users with the admin flag may update the profile for any account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account whose profile to update

Request Body schema: application/json
required
name
string or null <= 128 characters
bio
string or null <= 1024 characters
location
string or null <= 128 characters
url
string or null <uri>

Responses

Request samples

Content type
application/json
{
  • "name": "Isaac Asimov",
  • "bio": "Software Engineer @radiantearth",
  • "location": "Augsburg, Germany",
  • "url": "https://source.coop"
}

Response samples

Content type
application/json
{
  • "name": "Isaac Asimov",
  • "bio": "Software Engineer @radiantearth",
  • "location": "Augsburg, Germany",
  • "url": "https://source.coop"
}

Create a new account

Creates a new account. Authenticated users can only create a user account if they do not already have one. Only users with the create_organizations flag may create organization accounts. Users with the admin flag may create any account.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
account_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$
account_type
required
string (AccountType)
Enum: "user" "organization" "service"
required
object (AccountProfile)

Responses

Request samples

Content type
application/json
{
  • "account_id": "account-id",
  • "account_type": "user",
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "account_id": "account-id",
  • "account_type": "user",
  • "identity_id": "identity-id",
  • "disabled": true,
  • "profile": {
    },
  • "flags": [
    ]
}

Memberships

Invite a new member to an account.

Invites a new member to the specified account. For user accounts, you must be authenticated as the user account you are inviting the member to. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization account you are inviting the member to. Only users with the admin flag may invite members to service accounts.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to invite the member to

Request Body schema: application/json
required
account_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$
role
required
string (MembershipRole)
Enum: "owners" "maintainers" "read_data" "write_data"

Responses

Request samples

Content type
application/json
{
  • "account_id": "account-id",
  • "role": "owners"
}

Response samples

Content type
application/json
{
  • "membership_id": "00000000-0000-0000-0000-000000000000",
  • "account_id": "account-id",
  • "membership_account_id": "organization-id",
  • "repository_id": "repository-id",
  • "role": "owners",
  • "state": "invited",
  • "state_changed": "2019-08-24T14:15:22Z"
}

List the memberships for an account

Retrieves all memberships associated with the specified account. For user accounts, you must be authenticated as the user account you are listing memberships for. For organization accounts, you must be authenticated as either an owners or maintainers member of the organization account you are listing memberships for.

Only users with the admin flag may list memberships for service accounts.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to list memberships for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Accept a membership invitation.

Accepts a membership invitation for the specified membership. The user must be authorized to accept the membership.

Authorizations:
ApiKeyAuth
path Parameters
membership_id
required
string

The ID of the membership to accept

Responses

Response samples

Content type
application/json
{
  • "membership_id": "00000000-0000-0000-0000-000000000000",
  • "account_id": "account-id",
  • "membership_account_id": "organization-id",
  • "repository_id": "repository-id",
  • "role": "owners",
  • "state": "invited",
  • "state_changed": "2019-08-24T14:15:22Z"
}

Rejects a membership invitation.

Rejects a membership invitation for the specified membership. The user must be authorized to reject the membership.

Authorizations:
ApiKeyAuth
path Parameters
membership_id
required
string

The ID of the membership to reject

Responses

Response samples

Content type
application/json
{
  • "membership_id": "00000000-0000-0000-0000-000000000000",
  • "account_id": "account-id",
  • "membership_account_id": "organization-id",
  • "repository_id": "repository-id",
  • "role": "owners",
  • "state": "invited",
  • "state_changed": "2019-08-24T14:15:22Z"
}

Revokes a membership.

Revokes the specified membership. The user must be authorized to revoke the membership.

Authorizations:
ApiKeyAuth
path Parameters
membership_id
required
string

The ID of the membership to revoke

Responses

Response samples

Content type
application/json
{
  • "membership_id": "00000000-0000-0000-0000-000000000000",
  • "account_id": "account-id",
  • "membership_account_id": "organization-id",
  • "repository_id": "repository-id",
  • "role": "owners",
  • "state": "invited",
  • "state_changed": "2019-08-24T14:15:22Z"
}

Updates a membership role.

Updates the specified membership. The user must be authorized to update the membership.

Authorizations:
ApiKeyAuth
path Parameters
membership_id
required
string

The ID of the membership to update

Request Body schema: application/json
required
string (MembershipRole)
Enum: "owners" "maintainers" "read_data" "write_data"

Responses

Request samples

Content type
application/json
"owners"

Response samples

Content type
application/json
{
  • "membership_id": "00000000-0000-0000-0000-000000000000",
  • "account_id": "account-id",
  • "membership_account_id": "organization-id",
  • "repository_id": "repository-id",
  • "role": "owners",
  • "state": "invited",
  • "state_changed": "2019-08-24T14:15:22Z"
}

Invite a new member to a repository.

Invites a new member to the specified repository. For user accounts, you must be authenticated as the user account you are inviting the member to. For organization accounts, you must be authenticated as either an owners or maintainers member of the organization or repository you are inviting the member to. Users with the admin flag may invite users to any repository.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account that owns the repository

repository_id
required
string

The ID of the repository to invite the member to

Request Body schema: application/json
required
account_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$
role
required
string (MembershipRole)
Enum: "owners" "maintainers" "read_data" "write_data"

Responses

Request samples

Content type
application/json
{
  • "account_id": "account-id",
  • "role": "owners"
}

Response samples

Content type
application/json
{
  • "membership_id": "00000000-0000-0000-0000-000000000000",
  • "account_id": "account-id",
  • "membership_account_id": "organization-id",
  • "repository_id": "repository-id",
  • "role": "owners",
  • "state": "invited",
  • "state_changed": "2019-08-24T14:15:22Z"
}

List the memberships for a repository

Retrieves all memberships associated with the specified repository. For user accounts, you must be authenticated as the user account you are listing memberships for. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization or repository you are listing memberships for.

Users with the admin flag may list memberships for any repository.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account that owns the repository

repository_id
required
string

The ID of the repository to list memberships for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Data Connections

Get a data connection

Retrieves a data connection by its ID. Authentication credentials are only included for users with the appropriate permissions.

Authorizations:
ApiKeyAuth
path Parameters
data_connection_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data_connection_id": "data-connection-id",
  • "name": "string",
  • "prefix_template": "string",
  • "read_only": true,
  • "allowed_data_modes": [
    ],
  • "required_flag": "admin",
  • "details": {
    },
  • "authentication": {
    }
}

Update a data connection

Updates an existing data connection. Only users with the appropriate permissions can update data connections.

Authorizations:
ApiKeyAuth
path Parameters
data_connection_id
required
string
Request Body schema: application/json
required
data_connection_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$
name
required
string
prefix_template
string
read_only
required
boolean
allowed_data_modes
required
Array of strings
Items Enum: "open" "subscription" "private"
required_flag
string
Enum: "admin" "create_repositories" "create_organizations"
required
any (DataConnectionDetails)
any (DataConnectionAuthentication)

Responses

Request samples

Content type
application/json
{
  • "data_connection_id": "data-connection-id",
  • "name": "string",
  • "prefix_template": "string",
  • "read_only": true,
  • "allowed_data_modes": [
    ],
  • "required_flag": "admin",
  • "details": {
    },
  • "authentication": {
    }
}

Response samples

Content type
application/json
{
  • "data_connection_id": "data-connection-id",
  • "name": "string",
  • "prefix_template": "string",
  • "read_only": true,
  • "allowed_data_modes": [
    ],
  • "required_flag": "admin",
  • "details": {
    },
  • "authentication": {
    }
}

Disable a data connection

Disables a data connection by setting it to read-only. Only users with the appropriate permissions can disable data connections.

Authorizations:
ApiKeyAuth
path Parameters
data_connection_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data_connection_id": "data-connection-id",
  • "name": "string",
  • "prefix_template": "string",
  • "read_only": true,
  • "allowed_data_modes": [
    ],
  • "required_flag": "admin",
  • "details": {
    },
  • "authentication": {
    }
}

List data connections available to the user for repository creation

Retrieves a list of data connections which the user is allowed to use for creating repositories. The list is sanitized of data connection credentials based on the user's permissions.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List data connections

Retrieves a list of data connections. The list is sanitized of data connection credentials based on the user's permissions.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new data connection

Creates a new data connection. Only users with the admin flag may create data connections.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
data_connection_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$
name
required
string
prefix_template
string
read_only
required
boolean
allowed_data_modes
required
Array of strings
Items Enum: "open" "subscription" "private"
required_flag
string
Enum: "admin" "create_repositories" "create_organizations"
required
any (DataConnectionDetails)
any (DataConnectionAuthentication)

Responses

Request samples

Content type
application/json
{
  • "data_connection_id": "data-connection-id",
  • "name": "string",
  • "prefix_template": "string",
  • "read_only": true,
  • "allowed_data_modes": [
    ],
  • "required_flag": "admin",
  • "details": {
    },
  • "authentication": {
    }
}

Response samples

Content type
application/json
{
  • "data_connection_id": "data-connection-id",
  • "name": "string",
  • "prefix_template": "string",
  • "read_only": true,
  • "allowed_data_modes": [
    ],
  • "required_flag": "admin",
  • "details": {
    },
  • "authentication": {
    }
}

Repositories

Create a new API key

Creates a new API key for the specified repository. Only users who are an owners or maintainers member of the repository or organization may create an API Key. Users with the admin flag may create API keys for any repository.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account

repository_id
required
string

The ID of the repository to create the API key for

Request Body schema: application/json
required
name
required
string
expires
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "Dev Machine",
  • "expires": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "access_key_id": "SCFOOBAR",
  • "account_id": "account-id",
  • "repository_id": "repository-id",
  • "disabled": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "Dev Machine",
  • "secret_access_key": "stringstringstringstringstringstringstringstringstringstringstri"
}

List API keys for a repository

Retrieves all API keys associated with the specified repository. Only users who are an owners or maintainers member of the repository or organization may list API keys. Users with the admin flag may list API keys for any repository.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account

repository_id
required
string

The ID of the repository to list API keys for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an existing repository

Updates an existing repository for the specified account. For user accounts, you must be authenticated as the user account you are updating the repository for. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization you are updating the repository for.

Users with the admin flag may update repositories for any account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account that owns the repository

repository_id
required
string

The ID of the repository to update

Request Body schema: application/json
required
required
object (RepositoryMeta)
state
required
string (RepositoryState)
Enum: "listed" "unlisted"

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "state": "listed"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "repository_id": "string",
  • "state": "listed",
  • "data_mode": "open",
  • "featured": 1,
  • "meta": {
    },
  • "data": {
    },
  • "published": "2019-08-24T14:15:22Z",
  • "disabled": true
}

Disable an existing repository

Disables an existing repository for the specified account. For user accounts, you must be authenticated as the user account you are disabling the repository for. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization you are disabling the repository for.

Users with the admin flag may disable repositories for any account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account that owns the repository

repository_id
required
string

The ID of the repository to disable

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "repository_id": "string",
  • "state": "listed",
  • "data_mode": "open",
  • "featured": 1,
  • "meta": {
    },
  • "data": {
    },
  • "published": "2019-08-24T14:15:22Z",
  • "disabled": true
}

Get an existing repository

Retrieves an existing repository for the specified account. For user accounts, you must be authenticated as the user account you are retrieving the repository for. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization you are retrieving the repository from.

Users with the admin flag may retrieve repositories for any account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account that owns the repository

repository_id
required
string

The ID of the repository to retrieve

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "repository_id": "string",
  • "state": "listed",
  • "data_mode": "open",
  • "featured": 1,
  • "meta": {
    },
  • "data": {
    },
  • "published": "2019-08-24T14:15:22Z",
  • "disabled": true
}

Invite a new member to a repository.

Invites a new member to the specified repository. For user accounts, you must be authenticated as the user account you are inviting the member to. For organization accounts, you must be authenticated as either an owners or maintainers member of the organization or repository you are inviting the member to. Users with the admin flag may invite users to any repository.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account that owns the repository

repository_id
required
string

The ID of the repository to invite the member to

Request Body schema: application/json
required
account_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$
role
required
string (MembershipRole)
Enum: "owners" "maintainers" "read_data" "write_data"

Responses

Request samples

Content type
application/json
{
  • "account_id": "account-id",
  • "role": "owners"
}

Response samples

Content type
application/json
{
  • "membership_id": "00000000-0000-0000-0000-000000000000",
  • "account_id": "account-id",
  • "membership_account_id": "organization-id",
  • "repository_id": "repository-id",
  • "role": "owners",
  • "state": "invited",
  • "state_changed": "2019-08-24T14:15:22Z"
}

List the memberships for a repository

Retrieves all memberships associated with the specified repository. For user accounts, you must be authenticated as the user account you are listing memberships for. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization or repository you are listing memberships for.

Users with the admin flag may list memberships for any repository.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account that owns the repository

repository_id
required
string

The ID of the repository to list memberships for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new repository

Creates a new repository for the specified account. For user accounts, you must be authenticated as the user account you are creating the repository for. For organization accounts, you must be authenticated as either an owners or maintainers member for the organization you are creating the repository for.

Users with the admin flag may create repositories for any account.

Authorizations:
ApiKeyAuth
path Parameters
account_id
required
string

The ID of the account to create the repository for

Request Body schema: application/json
required
repository_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$
data_mode
required
string (RepositoryDataMode)
Enum: "open" "subscription" "private"
required
object (RepositoryMeta)
data_connection_id
required
string [ 3 .. 40 ] characters ^[a-z0-9](?:(?!--)[a-z0-9-])*[a-z0-9]$

Responses

Request samples

Content type
application/json
{
  • "repository_id": "string",
  • "data_mode": "open",
  • "meta": {
    },
  • "data_connection_id": "data-connection-id"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "repository_id": "string",
  • "state": "listed",
  • "data_mode": "open",
  • "featured": 1,
  • "meta": {
    },
  • "data": {
    },
  • "published": "2019-08-24T14:15:22Z",
  • "disabled": true
}

Authentication

Get the current user's session information. If the

Get the current user's session information. If the user is authenticated but has not created an account, the account field will be null. If the user is not authenticated, a 401 - Unauthorized response will be returned. This endpoint can be used to list all of the authenticated user's memberships.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "identity_id": "identity-id",
  • "account": {
    },
  • "memberships": [
    ]
}