|
5064 | 5064 | ], |
5065 | 5065 | "workspaceScope": "required", |
5066 | 5066 | "codeSamples": [ |
| 5067 | + { |
| 5068 | + "title": "Create an Access Grant for devices", |
| 5069 | + "description": "Creates a new Access Grant that gives a user identity a PIN code on one or more devices, such as standalone smart locks.", |
| 5070 | + "request": { |
| 5071 | + "path": "/access_grants/create", |
| 5072 | + "parameters": { |
| 5073 | + "user_identity_id": "e3d736c1-540d-4d10-83e5-9a4e135453b4", |
| 5074 | + "device_ids": [ |
| 5075 | + "6ba7b811-9dad-11d1-80b4-00c04fd430c8" |
| 5076 | + ], |
| 5077 | + "requested_access_methods": [ |
| 5078 | + { |
| 5079 | + "mode": "code" |
| 5080 | + } |
| 5081 | + ], |
| 5082 | + "starts_at": "2025-06-16T16:54:17.946606Z", |
| 5083 | + "ends_at": "2025-06-18T16:54:17.946606Z" |
| 5084 | + } |
| 5085 | + }, |
| 5086 | + "response": { |
| 5087 | + "body": { |
| 5088 | + "access_grant": { |
| 5089 | + "access_grant_id": "ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b", |
| 5090 | + "access_method_ids": [ |
| 5091 | + "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d" |
| 5092 | + ], |
| 5093 | + "created_at": "2025-06-16T16:54:17.946606Z", |
| 5094 | + "display_name": "My Access Grant", |
| 5095 | + "ends_at": "2025-06-18T16:54:17.946606Z", |
| 5096 | + "requested_access_methods": [ |
| 5097 | + { |
| 5098 | + "display_name": "PIN Code Credential", |
| 5099 | + "mode": "code", |
| 5100 | + "created_at": "2025-06-16T16:54:17.946606Z", |
| 5101 | + "created_access_method_ids": [ |
| 5102 | + "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d" |
| 5103 | + ] |
| 5104 | + } |
| 5105 | + ], |
| 5106 | + "starts_at": "2025-06-16T16:54:17.946606Z", |
| 5107 | + "user_identity_id": "e3d736c1-540d-4d10-83e5-9a4e135453b4", |
| 5108 | + "workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7" |
| 5109 | + } |
| 5110 | + } |
| 5111 | + }, |
| 5112 | + "code": { |
| 5113 | + "javascript": { |
| 5114 | + "title": "JavaScript", |
| 5115 | + "sdkName": "javascript", |
| 5116 | + "request": "await seam.accessGrants.create({\n user_identity_id: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n device_ids: [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"],\n requested_access_methods: [{ mode: \"code\" }],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n});", |
| 5117 | + "response": "{\n \"access_grant_id\": \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"My Access Grant\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\": [\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]\n }\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}", |
| 5118 | + "request_syntax": "javascript", |
| 5119 | + "response_syntax": "json" |
| 5120 | + }, |
| 5121 | + "python": { |
| 5122 | + "title": "Python", |
| 5123 | + "sdkName": "python", |
| 5124 | + "request": "seam.access_grants.create(\n user_identity_id=\"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n device_ids=[\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"],\n requested_access_methods=[{\"mode\": \"code\"}],\n starts_at=\"2025-06-16T16:54:17.946606Z\",\n ends_at=\"2025-06-18T16:54:17.946606Z\",\n)", |
| 5125 | + "response": "AccessGrant(\n access_grant_id=\"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n access_method_ids=[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n created_at=\"2025-06-16T16:54:17.946606Z\",\n display_name=\"My Access Grant\",\n ends_at=\"2025-06-18T16:54:17.946606Z\",\n requested_access_methods=[\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n }\n ],\n starts_at=\"2025-06-16T16:54:17.946606Z\",\n user_identity_id=\"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n workspace_id=\"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n)", |
| 5126 | + "request_syntax": "python", |
| 5127 | + "response_syntax": "python" |
| 5128 | + }, |
| 5129 | + "ruby": { |
| 5130 | + "title": "Ruby", |
| 5131 | + "sdkName": "ruby", |
| 5132 | + "request": "seam.access_grants.create(\n user_identity_id: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n device_ids: [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"],\n requested_access_methods: [{ mode: \"code\" }],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n)", |
| 5133 | + "response": "{\n \"access_grant_id\" => \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\" => [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n ],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}", |
| 5134 | + "request_syntax": "ruby", |
| 5135 | + "response_syntax": "ruby" |
| 5136 | + }, |
| 5137 | + "php": { |
| 5138 | + "title": "PHP", |
| 5139 | + "sdkName": "php", |
| 5140 | + "request": "$seam->access_grants->create(\n user_identity_id: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n device_ids: [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"],\n requested_access_methods: [[\"mode\" => \"code\"]],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n);", |
| 5141 | + "response": "[\n \"access_grant_id\" => \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\" => [\n [\n \"display_name\" => \"PIN Code Credential\",\n \"mode\" => \"code\",\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\" => [\n \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n ],\n ],\n ],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];", |
| 5142 | + "request_syntax": "php", |
| 5143 | + "response_syntax": "php" |
| 5144 | + }, |
| 5145 | + "seam_cli": { |
| 5146 | + "title": "Seam CLI", |
| 5147 | + "sdkName": "seam_cli", |
| 5148 | + "request": "seam access-grants create --user_identity_id \"e3d736c1-540d-4d10-83e5-9a4e135453b4\" --device_ids [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"] --requested_access_methods [{\"mode\":\"code\"}] --starts_at \"2025-06-16T16:54:17.946606Z\" --ends_at \"2025-06-18T16:54:17.946606Z\"", |
| 5149 | + "response": "{\n \"access_grant_id\": \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"My Access Grant\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\": [\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]\n }\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}", |
| 5150 | + "request_syntax": "bash", |
| 5151 | + "response_syntax": "json" |
| 5152 | + }, |
| 5153 | + "go": { |
| 5154 | + "title": "Go", |
| 5155 | + "sdkName": "go", |
| 5156 | + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.AccessGrants.Create(\n\t\tcontext.Background(),\n\t\tapi.AccessGrantsCreateRequest{\n\t\t\tUserIdentityId: api.String(\"e3d736c1-540d-4d10-83e5-9a4e135453b4\"),\n\t\t\tDeviceIds: [1]string{api.String(\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\")},\n\t\t\tRequestedAccessMethods: [1]api.AccessGrantsCreateRequestRequestedAccessMethodsItem{api.AccessGrantsCreateRequestRequestedAccessMethods{Mode: api.String(\"code\")}},\n\t\t\tStartsAt: api.String(\"2025-06-16T16:54:17.946606Z\"),\n\t\t\tEndsAt: api.String(\"2025-06-18T16:54:17.946606Z\"),\n\t\t},\n\t)\n}", |
| 5157 | + "response": "api.AccessGrant{AccessGrantId: \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\", AccessMethodIds: []string{\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"}, CreatedAt: \"2025-06-16T16:54:17.946606Z\", DisplayName: \"My Access Grant\", EndsAt: \"2025-06-18T16:54:17.946606Z\", RequestedAccessMethods: []AccessGrantRequestedAccessMethods{api.AccessGrantRequestedAccessMethodsRequestedAccessMethods{DisplayName: \"PIN Code Credential\", Mode: \"code\", CreatedAt: \"2025-06-16T16:54:17.946606Z\", CreatedAccessMethodIds: []string{\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"}}}, StartsAt: \"2025-06-16T16:54:17.946606Z\", UserIdentityId: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\", WorkspaceId: \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}", |
| 5158 | + "request_syntax": "go", |
| 5159 | + "response_syntax": "go" |
| 5160 | + }, |
| 5161 | + "java": { |
| 5162 | + "title": "Java", |
| 5163 | + "sdkName": "java", |
| 5164 | + "request": "seam.accessGrants().create(AccessGrantsCreateRequest.builder().userIdentityId(\"e3d736c1-540d-4d10-83e5-9a4e135453b4\")\n.deviceIds(List.of(\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"))\n.requestedAccessMethods(List.of(Map.of(\"mode\", \"code\")))\n.startsAt(\"2025-06-16T16:54:17.946606Z\")\n.endsAt(\"2025-06-18T16:54:17.946606Z\").build());", |
| 5165 | + "response": "{\n \"access_grant_id\": \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"My Access Grant\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\": [\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]\n }\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}", |
| 5166 | + "request_syntax": "java", |
| 5167 | + "response_syntax": "json" |
| 5168 | + }, |
| 5169 | + "csharp": { |
| 5170 | + "title": "C#", |
| 5171 | + "sdkName": "csharp", |
| 5172 | + "request": "seam.AccessGrants.Create(userIdentityId: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\", deviceIds: new string[] { \"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"} , requestedAccessMethods: new object[] { new { mode = \"code\" }} , startsAt: \"2025-06-16T16:54:17.946606Z\", endsAt: \"2025-06-18T16:54:17.946606Z\")", |
| 5173 | + "response": "{\n \"access_grant_id\": \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"My Access Grant\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\": [\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]\n }\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}", |
| 5174 | + "request_syntax": "csharp", |
| 5175 | + "response_syntax": "json" |
| 5176 | + }, |
| 5177 | + "curl": { |
| 5178 | + "title": "cURL", |
| 5179 | + "sdkName": "curl", |
| 5180 | + "request": "curl --include --request POST \"https://connect.getseam.com/access_grants/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <<EOF\n{\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"device_ids\": [\n \"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"\n ],\n \"requested_access_methods\": [\n {\n \"mode\": \"code\"\n }\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\"\n}\nEOF", |
| 5181 | + "response": "{\n \"access_grant\": {\n \"access_grant_id\": \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"display_name\": \"My Access Grant\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\": [\n {\n \"display_name\": \"PIN Code Credential\",\n \"mode\": \"code\",\n \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n \"created_access_method_ids\": [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]\n }\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n }\n}", |
| 5182 | + "request_syntax": "bash", |
| 5183 | + "response_syntax": "json" |
| 5184 | + } |
| 5185 | + } |
| 5186 | + }, |
5067 | 5187 | { |
5068 | 5188 | "title": "Create an Access Grant using spaces", |
5069 | 5189 | "description": "Creates a new Access Grant using space IDs and an existing user identity.", |
|
0 commit comments