Account | Orishare docs

Create a user, an organization with a default project and two environments, and a first token

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

Lengthlength <= 254

name?string

Length1 <= length <= 120

organization_name*string

Length1 <= length <= 120

timezone?string

Length1 <= length <= 64

Default"UTC"

offer?

Response Body

`application/json`

curl -X POST "https://example.com/auth/signup" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "organization_name": "Example",    "timezone": "UTC"  }'

{  "user": {    "id": "string",    "email": "string",    "name": "string",    "created_at": "2019-08-24T14:15:22Z"  },  "organization": {    "id": "string",    "name": "string",    "slug": "string"  },  "project": {    "id": "string",    "name": "string"  },  "environments": [    {      "id": "string",      "name": "string",      "runtime_class": "string"    }  ],  "token": {    "id": "string",    "token": "string",    "scopes": [      "string"    ]  }}

Create another organization owned by the caller, with a default project and two environments

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 120

timezone?string

Length1 <= length <= 64

Default"UTC"

Response Body

`application/json`

curl -X POST "https://example.com/organizations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "Example",    "timezone": "UTC"  }'

{  "organization": {    "id": "string",    "name": "string",    "slug": "string"  },  "project": {    "id": "string",    "name": "string"  },  "environments": [    {      "id": "string",      "name": "string",      "runtime_class": "string"    }  ]}

The caller and their memberships

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Header Parameters

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/users/me"

{  "id": "string",  "email": "string",  "name": "string",  "created_at": "2019-08-24T14:15:22Z",  "memberships": [    {      "organization_id": "string",      "user_id": "string",      "email": "string",      "role": "owner",      "created_at": "2019-08-24T14:15:22Z"    }  ]}

List the caller's tokens

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Query Parameters

limit?integer

Range1 <= value <= 200

Default50

cursor?string

Lengthlength <= 2048

purpose?"ai_access"

Only AI access keys

Value in

"ai_access"

Header Parameters

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/auth/tokens"

{  "data": [    {      "id": "string",      "name": "string",      "prefix": "string",      "scopes": [        "string"      ],      "expires_at": "2019-08-24T14:15:22Z",      "last_used_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "purpose": "ai_access",      "organization_id": "string",      "environment_ids": [        "string"      ],      "default_environment_id": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Issue a personal access token with scopes, or an AI access key (purpose ai_access) narrowed to an organization, environments and a default environment

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 120

scopes?array<>

The scopes; or give access instead

Items1 <= items <= 80

access?string

ADR 0065: read = every read scope, full = * (both bounded by your role); instead of scopes

Value in

"read"
"full"

expires_in_days?integer

Range1 <= value <= 365

purpose?"ai_access"

ai_access: an AI access key, listed under Settings, AI connections

Value in

"ai_access"

organization_id?|

The only organization the token may act in; omitted or null = all

environment_ids?array<>|

Environments of organization_id the token may act in; null = all

default_environment_id?|

Selected when a request sends no X-Orishare-Environment

Response Body

`application/json`

curl -X POST "https://example.com/auth/tokens" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "Server",    "scopes": [      "organizations:read"    ]  }'

{  "id": "string",  "name": "string",  "prefix": "string",  "scopes": [    "string"  ],  "expires_at": "2019-08-24T14:15:22Z",  "last_used_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "purpose": "ai_access",  "organization_id": "string",  "environment_ids": [    "string"  ],  "default_environment_id": "string",  "token": "string"}

Revoke a token (the current one included)

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Path Parameters

id*string

Length1 <= length

Header Parameters

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/auth/tokens/string"

Empty

Invite a user by email with a role

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Path Parameters

id*string

Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

Lengthlength <= 254

role*string

Value in

"owner"
"admin"
"editor"
"viewer"

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/invitations" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "role": "viewer"  }'

{  "id": "string",  "organization_id": "string",  "email": "string",  "role": "owner",  "expires_at": "2019-08-24T14:15:22Z",  "accepted_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "token": "string"}

Path Parameters

id*string

Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

token*string

Length10 <= length

name?string

Length1 <= length <= 120

Response Body

`application/json`

curl -X POST "https://example.com/invitations/string/accept" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "token": "inv_example_secret"  }'

{  "user": {    "id": "string",    "email": "string",    "name": "string",    "created_at": "2019-08-24T14:15:22Z"  },  "membership": {    "organization_id": "string",    "user_id": "string",    "email": "string",    "role": "owner",    "created_at": "2019-08-24T14:15:22Z"  },  "token": {    "id": "string",    "token": "string",    "scopes": [      "string"    ]  }}

List members

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Path Parameters

id*string

Length1 <= length

Query Parameters

limit?integer

Range1 <= value <= 200

Default50

cursor?string

Lengthlength <= 2048

Header Parameters

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/memberships"

{  "data": [    {      "organization_id": "string",      "user_id": "string",      "email": "string",      "role": "owner",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Change a member's role

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Path Parameters

id*string

user_id*string

Header Parameters

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

role*string

Value in

"admin"
"editor"
"viewer"

Response Body

`application/json`

curl -X PATCH "https://example.com/organizations/string/memberships/string" \  -H "Content-Type: application/json" \  -d '{    "role": "editor"  }'

{  "organization_id": "string",  "user_id": "string",  "email": "string",  "role": "owner",  "created_at": "2019-08-24T14:15:22Z"}

Remove a member (never the last owner)

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Path Parameters

id*string

user_id*string

Header Parameters

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/organizations/string/memberships/string"

Empty

Transfer ownership to another member; the caller becomes admin

Authorization

AuthorizationBearer <token>

Personal access token. Scopes are listed in x-orishare-authorization.

In: header

Path Parameters

id*string

Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

user_id*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/transfer_ownership" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "user_id": "usr_next"  }'

{  "owner": {    "organization_id": "string",    "user_id": "string",    "email": "string",    "role": "owner",    "created_at": "2019-08-24T14:15:22Z"  },  "previous_owner": {    "organization_id": "string",    "user_id": "string",    "email": "string",    "role": "owner",    "created_at": "2019-08-24T14:15:22Z"  }}

Authorization

session

__Secure-orishare.session_token<token>

Browser session; local and staging use their configured runtime cookie prefix.

In: cookie

Path Parameters

id*string

Length1 <= length <= 64

Response Body

`application/json`

curl -X GET "https://example.com/oauth/authorization_requests/string"

{  "id": "string",  "expires_at": "string",  "client": {    "client_id": "string",    "name": "string",    "logo_uri": "string",    "client_uri": "string",    "domain": "string",    "registration": "metadata_document",    "verified": false  },  "redirect_uri": "string",  "redirect_host": "string",  "loopback_redirect": true,  "requested_access": "read",  "user": {    "id": "string",    "email": "string",    "name": "string"  },  "organizations": [    {      "id": "string",      "name": "string",      "role": "owner",      "environments": [        {          "id": "string",          "name": "string",          "runtime_class": "sandbox"        }      ]    }  ]}

Allow or deny an AI app: allow grants it one organization, chosen environments and an access level

Authorization

session

__Secure-orishare.session_token<token>

Browser session; local and staging use their configured runtime cookie prefix.

In: cookie

Path Parameters

id*string

Length1 <= length <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

decision*string

Value in

"allow"
"deny"

organization_id?string

Length1 <= length

environment_ids?array<>|null

default_environment_id?|null

access?string

Value in

"read"
"full"

expires_in_days?number|number|number|null

Response Body

`application/json`

curl -X POST "https://example.com/oauth/authorization_requests/string/decision" \  -H "Content-Type: application/json" \  -d '{    "decision": "allow",    "organization_id": "org_example",    "environment_ids": [      "env_example"    ],    "default_environment_id": "env_example",    "access": "read",    "expires_in_days": 90  }'

{  "redirect_to": "string"}

Connected apps: the AI apps the signed-in person allowed, newest first

Authorization

session

__Secure-orishare.session_token<token>

Browser session; local and staging use their configured runtime cookie prefix.

In: cookie

Response Body

`application/json`

curl -X GET "https://example.com/oauth/grants"

{  "data": [    {      "id": "string",      "client": {        "client_id": "string",        "name": "string",        "logo_uri": "string",        "domain": "string",        "registration": "metadata_document"      },      "organization": {        "id": "string",        "name": "string"      },      "environment_ids": [        "string"      ],      "default_environment_id": "string",      "access": "read",      "created_at": "string",      "last_used_at": "string",      "expires_at": "string"    }  ]}

Disconnect an AI app: revokes its access and every token at once

Authorization

session

__Secure-orishare.session_token<token>

Browser session; local and staging use their configured runtime cookie prefix.

In: cookie

Path Parameters

id*string

Length1 <= length <= 64

Response Body

`application/json`

curl -X DELETE "https://example.com/oauth/grants/string"

Empty

The calling credential and the scopes it holds in its environment now

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/principal"

{  "kind": "secret_key",  "id": "string",  "token_id": "string",  "staff": true,  "organization_id": "string",  "environment_id": "string",  "scopes": [    "string"  ]}

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

503application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

204

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`