Skip to content

Organizations

Create source permission import

Stage a complete permission snapshot without changing active access. Upload numbered CSV parts, then complete the import within 24 hours using the same credential. Requires organization Admin access. Existing inline uploads remain supported. OAuth scope: `api:write`.

POST/api/v2/organizations/{organizationId}/search/sources/{sourceId}/permissions/imports

Stage a complete permission snapshot without changing active access. Upload numbered CSV parts, then complete the import within 24 hours using the same credential. Requires organization Admin access. Existing inline uploads remain supported.

OAuth scope: api:write.

Authentication

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

Send X-API-Key in the request header.

Alternatively

Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.

Authorization: Bearer YOUR_ACCESS_TOKEN

Required scopes: api:write

OAuth flows
json
{
  "authorizationCode": {
    "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
    "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "scopes": {
      "api:read": "Read your workspaces, workflows, files, tables, and logs",
      "api:write": "Read, create, change, run, and delete resources in your workspaces",
      "offline_access": "Stay signed in without asking again"
    }
  }
}

OAuth scope: api:write.

Path parameters

organizationIdstringRequired

Organization identifier.

minLength
1
sourceIdstringRequired

Search source identifier.

minLength
1

Request body

Required

Permission import input.

object

Permission import input.

4 fields
providerstringRequired

Provider of the configured source.

const
gitlab
expectedRevisionintegerRequired

Permission revision pinned before exporting the CSVs.

maximum
2147483646
exclusiveMinimum
0
userMappingobjectRequired

Complete user identity mapping.

3 fields
filenamestringRequired

CSV filename without path separators.

minLength
1
maxLength
255
pattern
^[^\p{Cc}/\\]+$
partsintegerRequired

Number of nonempty parts containing this file. Both files together may contain at most 4,096 parts.

minimum
1
maximum
4096
rowCountintegerRequired

Physical user records, excluding headers and empty lines. Must be between parts and parts × 5,000.

minimum
1
maximum
500000

Additional properties are not allowed.

projectPermissionsobjectRequired

Complete project membership snapshot.

3 fields
filenamestringRequired

CSV filename without path separators.

minLength
1
maxLength
255
pattern
^[^\p{Cc}/\\]+$
partsintegerRequired

Number of nonempty parts containing this file. Both files together may contain at most 4,096 parts.

minimum
1
maximum
4096
rowCountintegerRequired

Physical data records, excluding headers and empty lines. Must be between parts and parts × 5,000.

minimum
1
maximum
5000000

Additional properties are not allowed.

Additional properties are not allowed.

Responses

201

Permission import result.

object

Permission import result.

1 field
dataobjectRequired

Response data.

2 fields
idstringRequired

Permission import identifier.

expiresAtstringRequired

Upload completion deadline in UTC.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Additional properties are not allowed.

Additional properties are not allowed.

Response headers

X-RateLimit-Limitinteger

Maximum requests allowed in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Remaininginteger

Requests remaining in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Resetstring

ISO 8601 timestamp when the current rate-limit window resets.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Was this helpful?
Suggest an edit