Save how the organization signs in to AWS
curl --request PUT \
--url https://api.openworklabs.com/v1/managed-deployments/aws-sign-in \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"awsSignIn": {
"portalUrl": "<string>",
"roleName": "<string>"
}
}
'import requests
url = "https://api.openworklabs.com/v1/managed-deployments/aws-sign-in"
payload = { "awsSignIn": {
"portalUrl": "<string>",
"roleName": "<string>"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({awsSignIn: {portalUrl: '<string>', roleName: '<string>'}})
};
fetch('https://api.openworklabs.com/v1/managed-deployments/aws-sign-in', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/managed-deployments/aws-sign-in",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'awsSignIn' => [
'portalUrl' => '<string>',
'roleName' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/managed-deployments/aws-sign-in"
payload := strings.NewReader("{\n \"awsSignIn\": {\n \"portalUrl\": \"<string>\",\n \"roleName\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.openworklabs.com/v1/managed-deployments/aws-sign-in")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"awsSignIn\": {\n \"portalUrl\": \"<string>\",\n \"roleName\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/managed-deployments/aws-sign-in")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"awsSignIn\": {\n \"portalUrl\": \"<string>\",\n \"roleName\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"awsSignIn": {
"portalUrl": "<string>",
"roleName": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Managed deployments
Save how the organization signs in to AWS
Saves the organization’s AWS access portal URL and the role to open the console with, or removes them with awsSignIn null. While saved, every AWS link (approval link, CloudShell, CloudFormation stack) opens through the portal in the deployment’s own account, so an approver lands signed in to the right account. Only AWS-hosted access portal addresses are accepted.
PUT
/
v1
/
managed-deployments
/
aws-sign-in
Save how the organization signs in to AWS
curl --request PUT \
--url https://api.openworklabs.com/v1/managed-deployments/aws-sign-in \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"awsSignIn": {
"portalUrl": "<string>",
"roleName": "<string>"
}
}
'import requests
url = "https://api.openworklabs.com/v1/managed-deployments/aws-sign-in"
payload = { "awsSignIn": {
"portalUrl": "<string>",
"roleName": "<string>"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({awsSignIn: {portalUrl: '<string>', roleName: '<string>'}})
};
fetch('https://api.openworklabs.com/v1/managed-deployments/aws-sign-in', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openworklabs.com/v1/managed-deployments/aws-sign-in",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'awsSignIn' => [
'portalUrl' => '<string>',
'roleName' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/managed-deployments/aws-sign-in"
payload := strings.NewReader("{\n \"awsSignIn\": {\n \"portalUrl\": \"<string>\",\n \"roleName\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.openworklabs.com/v1/managed-deployments/aws-sign-in")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"awsSignIn\": {\n \"portalUrl\": \"<string>\",\n \"roleName\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/managed-deployments/aws-sign-in")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"awsSignIn\": {\n \"portalUrl\": \"<string>\",\n \"roleName\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"awsSignIn": {
"portalUrl": "<string>",
"roleName": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
denApiKeybearerAuth
Was this page helpful?