POST /projects/{projectId}/members

← Projects

POST

/v1/projects/{projectId}/members

Create a member

Host

https://api.embodiflow.io/v1
https://api.embodiflow.dev/v1

认证

Authorization: Bearer PAT

参数

名称	位置	类型	必填	说明
projectId	path	string	是	OpenAPI 中未发布
Idempotency-Key	header	string	否	Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

请求体

Content-Type: application/json
Schema: object

{
  "type": "object",
  "properties": {
    "membershipId": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "owner",
        "editor",
        "reviewer",
        "labeler",
        "viewer",
        "uploader",
        "data_supplier"
      ]
    },
    "roles": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string"
      },
      "enum": [
        "owner",
        "editor",
        "reviewer",
        "labeler",
        "viewer",
        "uploader",
        "data_supplier"
      ]
    }
  },
  "required": [
    "membershipId"
  ]
}

响应

状态码	说明	Content-Type	Schema
201	Success	application/json	object
400	Bad request. Enumerated catalog codes for this operation.	application/problem+json	union
401	Authentication failed. A specific TOKEN_* cause is returned only when the presented hash matched a stored row.	application/problem+json	union
403	Authorization failed. PERMISSION_DENIED on an any-of route lists the alternatives in message.	application/problem+json	union
404	Not found. Enumerated catalog codes for this operation.	application/problem+json	union
409	Conflict. Enumerated catalog codes for this operation.	application/problem+json	union
429	Authenticated per-principal or per-tenant request budget exceeded. Rate-limit headers appear only on 429.	application/problem+json	union

{
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/ProjectMemberDto"
    }
  },
  "required": [
    "data"
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/ProblemJson"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            400
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "BAD_REQUEST",
            "IDEMPOTENCY_KEY_INVALID",
            "IF_MATCH_INVALID",
            "IMPORT_EXECUTION_FAILED",
            "IMPORT_VALIDATION_FAILED",
            "INVALID_PERMISSION_OVERLAY",
            "INVALID_ROLE_TRANSITION",
            "TENANT_CONTEXT_MISMATCH",
            "TENANT_REQUIRED",
            "VALIDATION_ERROR",
            "WORKFLOW_DEFINITION_REVISION_NOT_PUBLISHED"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PublishedAuthProblem"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            401
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "TOKEN_MALFORMED",
            "TOKEN_NOT_FOUND",
            "TOKEN_EXPIRED",
            "TOKEN_REVOKED",
            "UNAUTHORIZED",
            "SESSION_EXPIRED",
            "ACTIVATION_REQUIRED",
            "MFA_REQUIRED"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PublishedAuthProblem"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            403
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "PERMISSION_DENIED",
            "PERMISSION_NOT_DECLARED",
            "FORBIDDEN",
            "MEMBERSHIP_NOT_FOUND",
            "MEMBERSHIP_DISABLED",
            "MEMBERSHIP_EXPIRED",
            "PROJECT_MEMBERSHIP_EXPIRED"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/ProblemJson"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            404
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "IMPORT_JOB_NOT_FOUND",
            "IMPORT_SOURCE_NOT_FOUND",
            "NOT_FOUND",
            "PIPELINE_BINDING_NOT_FOUND",
            "PROJECT_NOT_FOUND",
            "RESOURCE_NOT_FOUND",
            "USER_NOTIFICATION_NOT_FOUND",
            "WORKFLOW_DEFINITION_NOT_FOUND",
            "WORKFLOW_NOT_FOUND",
            "WORKFLOW_NOT_VISIBLE",
            "WORKFLOW_REVISION_NOT_FOUND"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/ProblemJson"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            409
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "IDEMPOTENCY_CONFLICT",
            "IMPORT_SOURCE_CHANGED",
            "LAST_OWNER_PROTECTION",
            "PIPELINE_BINDING_ALREADY_EXISTS",
            "SLUG_GENERATION_CONFLICT",
            "WORKFLOW_DEFINITION_CODE_CONFLICT"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PublishedAuthProblem"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            429
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "RATE_LIMITED"
          ]
        }
      }
    }
  ]
}

示例

curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/members' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{}'

参数

名称	位置	类型	必填	说明
projectId	path	string	是	OpenAPI 中未发布
Idempotency-Key	header	string	否	Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

请求体

Content-Type: application/json
Schema: object

{
  "type": "object",
  "properties": {
    "membershipId": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "owner",
        "editor",
        "reviewer",
        "labeler",
        "viewer",
        "uploader",
        "data_supplier"
      ]
    },
    "roles": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string"
      },
      "enum": [
        "owner",
        "editor",
        "reviewer",
        "labeler",
        "viewer",
        "uploader",
        "data_supplier"
      ]
    }
  },
  "required": [
    "membershipId"
  ]
}

响应

状态码	说明	Content-Type	Schema
201	Success	application/json	object
400	Bad request. Enumerated catalog codes for this operation.	application/problem+json	union
401	Authentication failed. A specific TOKEN_* cause is returned only when the presented hash matched a stored row.	application/problem+json	union
403	Authorization failed. PERMISSION_DENIED on an any-of route lists the alternatives in message.	application/problem+json	union
404	Not found. Enumerated catalog codes for this operation.	application/problem+json	union
409	Conflict. Enumerated catalog codes for this operation.	application/problem+json	union
429	Authenticated per-principal or per-tenant request budget exceeded. Rate-limit headers appear only on 429.	application/problem+json	union

{ "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectMemberDto" } }, "required": [ "data" ] }

{ "allOf": [ { "$ref": "#/components/schemas/ProblemJson" }, { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 400 ] }, "code": { "type": "string", "enum": [ "BAD_REQUEST", "IDEMPOTENCY_KEY_INVALID", "IF_MATCH_INVALID", "IMPORT_EXECUTION_FAILED", "IMPORT_VALIDATION_FAILED", "INVALID_PERMISSION_OVERLAY", "INVALID_ROLE_TRANSITION", "TENANT_CONTEXT_MISMATCH", "TENANT_REQUIRED", "VALIDATION_ERROR", "WORKFLOW_DEFINITION_REVISION_NOT_PUBLISHED" ] } } } ] }

{ "allOf": [ { "$ref": "#/components/schemas/PublishedAuthProblem" }, { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 401 ] }, "code": { "type": "string", "enum": [ "TOKEN_MALFORMED", "TOKEN_NOT_FOUND", "TOKEN_EXPIRED", "TOKEN_REVOKED", "UNAUTHORIZED", "SESSION_EXPIRED", "ACTIVATION_REQUIRED", "MFA_REQUIRED" ] } } } ] }

{ "allOf": [ { "$ref": "#/components/schemas/PublishedAuthProblem" }, { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 403 ] }, "code": { "type": "string", "enum": [ "PERMISSION_DENIED", "PERMISSION_NOT_DECLARED", "FORBIDDEN", "MEMBERSHIP_NOT_FOUND", "MEMBERSHIP_DISABLED", "MEMBERSHIP_EXPIRED", "PROJECT_MEMBERSHIP_EXPIRED" ] } } } ] }

{ "allOf": [ { "$ref": "#/components/schemas/ProblemJson" }, { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 404 ] }, "code": { "type": "string", "enum": [ "IMPORT_JOB_NOT_FOUND", "IMPORT_SOURCE_NOT_FOUND", "NOT_FOUND", "PIPELINE_BINDING_NOT_FOUND", "PROJECT_NOT_FOUND", "RESOURCE_NOT_FOUND", "USER_NOTIFICATION_NOT_FOUND", "WORKFLOW_DEFINITION_NOT_FOUND", "WORKFLOW_NOT_FOUND", "WORKFLOW_NOT_VISIBLE", "WORKFLOW_REVISION_NOT_FOUND" ] } } } ] }

{ "allOf": [ { "$ref": "#/components/schemas/ProblemJson" }, { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 409 ] }, "code": { "type": "string", "enum": [ "IDEMPOTENCY_CONFLICT", "IMPORT_SOURCE_CHANGED", "LAST_OWNER_PROTECTION", "PIPELINE_BINDING_ALREADY_EXISTS", "SLUG_GENERATION_CONFLICT", "WORKFLOW_DEFINITION_CODE_CONFLICT" ] } } } ] }

{ "allOf": [ { "$ref": "#/components/schemas/PublishedAuthProblem" }, { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 429 ] }, "code": { "type": "string", "enum": [ "RATE_LIMITED" ] } } } ] }