{"_id":"5c22429d801c320043a61b76","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":46,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5c22412594a2a5005cc9e919","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-12-25T14:39:33.459Z","from_sync":false,"order":31,"slug":"sb-cli","title":"SB Command Line Interface"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-25T14:45:49.577Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"##Overview\n\nUse the following commands to manage your projects and project members on the CGC.\n\n##projects create\n\nCreate a new project with a desired name and a chosen billing group.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb projects create --name <name_value> --billing_group <billing_group_value> [--description <description_value>] [--locked <locked_value>] [flags]\\n\\nFlags:\\n      --name string            The name given to a new project.\\n      --billing_group string   The ID of the billing group for the project.\\n      --description string     A human-readable description of the project.\\n      --locked string          Prevents any Seven Bridges team member from viewing the project. (default \\\"no\\\")\\n  -h, --help                   help for create\",\n      \"language\": \"text\",\n      \"name\": \"projects create\"\n    }\n  ]\n}\n[/block]\n##projects list\n\nList the projects accessible to the current user.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb projects list [--user <user_value>] [flags]\\n\\nFlags:\\n      --user string   List only projects owned by the specified user.\\n  -h, --help          help for list\",\n      \"language\": \"text\",\n      \"name\": \"projects list\"\n    }\n  ]\n}\n[/block]\n##projects get\n\nGet details of the specified project. Note that the project_id takes the form of `{project_owner}/{project}`, where `{project_owner}` is the username of the user who created the project and {project} is not the project's full given name, but its [short name](doc:the-api#project-short-name.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb projects get <project_id> [flags]\\n\\nArguments:\\n      project_id   ID of the project.\\n\\nFlags:\\n  -h, --help   help for get\",\n      \"language\": \"text\",\n      \"name\": \"projects get\"\n    }\n  ]\n}\n[/block]\n##projects update\n\nChange the name, description, or billing group of a project. Note that the project_id takes the form of `{project_owner}/{project}`, where `{project_owner}` is the username of the user who created the project and that {project} is not the project's full given name but its short name.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb projects update <project_id> [--name <name_value>] [--billing_group <billing_group_value>] [--description <description_value>] [--locked <locked_value>] [flags]\\n\\nArguments:\\n      project_id   ID of the project.\\n\\nFlags:\\n      --name string            The new name given to the project.\\n      --billing_group string   The ID of the new billing group for the project.\\n      --description string     A human-readable new description of the project.\\n      --locked string          Prevents any Seven Bridges team member from viewing the project. (default \\\"no\\\")\\n  -h, --help                   help for update\\n\",\n      \"language\": \"text\",\n      \"name\": \"projects update\"\n    }\n  ]\n}\n[/block]\n##projects delete\nDelete a project from the CGC. Note that this completely erases the project and any related data.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb projects delete <project_id> [flags]\\n\\nArguments:\\n      project_id   ID of the project.\\n\\nFlags:\\n  -h, --help   help for delete\",\n      \"language\": \"text\",\n      \"name\": \"projects delete\"\n    }\n  ]\n}\n[/block]\n##members create \n\nAdd an existing member to the specified project with appropriate permissions. This request can only be successfully made by a user who has admin permissions in the project.\n\nUsers may have the following permissions on the CGC:\n\n  * Read\n  * Write\n  * Copy\n  * Execute\n  * Admin\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb members create --project <project_value> --user <user_value> [--read] [--write] [--copy] [--execute] [--admin] [flags]\\n\\nFlags:\\n      --project string   The ID of the project you are adding a new member to.\\n      --user string      The username of the person you are adding to the project.\\n      --read             The member can view file names, metadata, and workflows. This is automatically assigned when a member is created. (default true)\\n      --write            The member can add, modify, and remove files and workflows.\\n      --copy             The member can view file content, copy, and download files.\\n      --execute          The member can execute workflows and abort tasks.\\n      --admin            The member can modify another user's permissions, add or remove people, and manage funding sources.\",\n      \"language\": \"text\",\n      \"name\": \"members create\"\n    }\n  ]\n}\n[/block]\n##members list\n\nGet a list of the members of the specified project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb members list --project <project_value> [flags]\\n\\nFlags:\\n      --project string   The project for which to return the list of members.\\n  -h, --help             help for list\",\n      \"language\": \"text\",\n      \"name\": \"members list\"\n    }\n  ]\n}\n[/block]\n##members get\n\nGet member permissions for a given project.\n\nUsers may have the following permissions on the Seven Bridges CGC:\n\n* Read\n* Write\n* Copy\n* Execute\n* Admin\n\nPermissions are granted at the project-level. You may, for instance, have admin permission in one project, execute permission in another, and read-only permission in a third.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb members get --project <project_value> --user <user_value> [flags]\\n\\nFlags:\\n      --project string   The ID of the project containing the member(s) whose permissions you are querying.\\n      --user string      The username of the member whose permissions you are querying.\\n  -h, --help             help for get\",\n      \"language\": \"text\",\n      \"name\": \"members get\"\n    }\n  ]\n}\n[/block]\n ##members update\n\nUpdate a project member's permission for the specified project. It can only be successfully made if you have admin status for the project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb members update --project <project_value> --user <user_value> [--read] [--write] [--copy] [--execute] [--admin] [flags]\\n\\nFlags:\\n      --project string   The ID of the project containing the member whose permissions you’d like to update.\\n      --user string      The username of the project member whose permissions you are updating.\\n      --read             This permission allows a project member to view file names, metadata, and workflows. Read permissions are assigned by default. (default true)\\n      --write            This permission allows a project member to add, modify, and remove files and workflows.\\n      --copy             This permission allows a project member to view file content, copy, and download files.\\n      --execute          This permission allows a project member to execute workflows and abort tasks.\\n      --admin            This permission allows a project member to modify another user's permissions, add or remove people, and manage funding sources.\\n  -h, --help             help for update\",\n      \"language\": \"text\",\n      \"name\": \"members update\"\n    }\n  ]\n}\n[/block]\n ##members delete\n\nRemove a member from the specified project. This command can only be successfully run by a user who has admin privileges in the specified project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb members delete --project <project_value> --user <user_value> [flags]\\n\\nFlags:\\n      --project string   The ID of the project from which you are removing a member.\\n      --user string      The username of the member you are removing.\\n  -h, --help             help for delete\\n\",\n      \"language\": \"text\",\n      \"name\": \"members delete\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"projects-and-members","type":"basic","title":"Projects and members"}

Projects and members


##Overview Use the following commands to manage your projects and project members on the CGC. ##projects create Create a new project with a desired name and a chosen billing group. [block:code] { "codes": [ { "code": "Usage:\n sb projects create --name <name_value> --billing_group <billing_group_value> [--description <description_value>] [--locked <locked_value>] [flags]\n\nFlags:\n --name string The name given to a new project.\n --billing_group string The ID of the billing group for the project.\n --description string A human-readable description of the project.\n --locked string Prevents any Seven Bridges team member from viewing the project. (default \"no\")\n -h, --help help for create", "language": "text", "name": "projects create" } ] } [/block] ##projects list List the projects accessible to the current user. [block:code] { "codes": [ { "code": "Usage:\n sb projects list [--user <user_value>] [flags]\n\nFlags:\n --user string List only projects owned by the specified user.\n -h, --help help for list", "language": "text", "name": "projects list" } ] } [/block] ##projects get Get details of the specified project. Note that the project_id takes the form of `{project_owner}/{project}`, where `{project_owner}` is the username of the user who created the project and {project} is not the project's full given name, but its [short name](doc:the-api#project-short-name. [block:code] { "codes": [ { "code": "Usage:\n sb projects get <project_id> [flags]\n\nArguments:\n project_id ID of the project.\n\nFlags:\n -h, --help help for get", "language": "text", "name": "projects get" } ] } [/block] ##projects update Change the name, description, or billing group of a project. Note that the project_id takes the form of `{project_owner}/{project}`, where `{project_owner}` is the username of the user who created the project and that {project} is not the project's full given name but its short name. [block:code] { "codes": [ { "code": "Usage:\n sb projects update <project_id> [--name <name_value>] [--billing_group <billing_group_value>] [--description <description_value>] [--locked <locked_value>] [flags]\n\nArguments:\n project_id ID of the project.\n\nFlags:\n --name string The new name given to the project.\n --billing_group string The ID of the new billing group for the project.\n --description string A human-readable new description of the project.\n --locked string Prevents any Seven Bridges team member from viewing the project. (default \"no\")\n -h, --help help for update\n", "language": "text", "name": "projects update" } ] } [/block] ##projects delete Delete a project from the CGC. Note that this completely erases the project and any related data. [block:code] { "codes": [ { "code": "Usage:\n sb projects delete <project_id> [flags]\n\nArguments:\n project_id ID of the project.\n\nFlags:\n -h, --help help for delete", "language": "text", "name": "projects delete" } ] } [/block] ##members create Add an existing member to the specified project with appropriate permissions. This request can only be successfully made by a user who has admin permissions in the project. Users may have the following permissions on the CGC: * Read * Write * Copy * Execute * Admin [block:code] { "codes": [ { "code": "Usage:\n sb members create --project <project_value> --user <user_value> [--read] [--write] [--copy] [--execute] [--admin] [flags]\n\nFlags:\n --project string The ID of the project you are adding a new member to.\n --user string The username of the person you are adding to the project.\n --read The member can view file names, metadata, and workflows. This is automatically assigned when a member is created. (default true)\n --write The member can add, modify, and remove files and workflows.\n --copy The member can view file content, copy, and download files.\n --execute The member can execute workflows and abort tasks.\n --admin The member can modify another user's permissions, add or remove people, and manage funding sources.", "language": "text", "name": "members create" } ] } [/block] ##members list Get a list of the members of the specified project. [block:code] { "codes": [ { "code": "Usage:\n sb members list --project <project_value> [flags]\n\nFlags:\n --project string The project for which to return the list of members.\n -h, --help help for list", "language": "text", "name": "members list" } ] } [/block] ##members get Get member permissions for a given project. Users may have the following permissions on the Seven Bridges CGC: * Read * Write * Copy * Execute * Admin Permissions are granted at the project-level. You may, for instance, have admin permission in one project, execute permission in another, and read-only permission in a third. [block:code] { "codes": [ { "code": "Usage:\n sb members get --project <project_value> --user <user_value> [flags]\n\nFlags:\n --project string The ID of the project containing the member(s) whose permissions you are querying.\n --user string The username of the member whose permissions you are querying.\n -h, --help help for get", "language": "text", "name": "members get" } ] } [/block] ##members update Update a project member's permission for the specified project. It can only be successfully made if you have admin status for the project. [block:code] { "codes": [ { "code": "Usage:\n sb members update --project <project_value> --user <user_value> [--read] [--write] [--copy] [--execute] [--admin] [flags]\n\nFlags:\n --project string The ID of the project containing the member whose permissions you’d like to update.\n --user string The username of the project member whose permissions you are updating.\n --read This permission allows a project member to view file names, metadata, and workflows. Read permissions are assigned by default. (default true)\n --write This permission allows a project member to add, modify, and remove files and workflows.\n --copy This permission allows a project member to view file content, copy, and download files.\n --execute This permission allows a project member to execute workflows and abort tasks.\n --admin This permission allows a project member to modify another user's permissions, add or remove people, and manage funding sources.\n -h, --help help for update", "language": "text", "name": "members update" } ] } [/block] ##members delete Remove a member from the specified project. This command can only be successfully run by a user who has admin privileges in the specified project. [block:code] { "codes": [ { "code": "Usage:\n sb members delete --project <project_value> --user <user_value> [flags]\n\nFlags:\n --project string The ID of the project from which you are removing a member.\n --user string The username of the member you are removing.\n -h, --help help for delete\n", "language": "text", "name": "members delete" } ] } [/block]