Credentials API
Beta
A credential is a login that Steel stores encrypted and fills in on its origin's sign-in pages. Its origin and namespace identify it. These endpoints store, list, update and delete credentials. For the base URL and authentication, see API conventions. For the error codes, see Errors.
The first example is a complete program that stores a login for https://app.example.com, with the password from the SITE_PASSWORD environment variable. The later examples use its client.
Endpoints
Store a credential
POST/v1/credentials
Encrypts and stores the credential of one origin.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
origin | string · body | No | The website origin of the credential, such as https://. Set it. Without it, the origin is "default", which matches no page.Default "default". |
value | object · body | Yes | The credential, as string fields: username, password, and totpSecret for one-time passwords. |
label | string · body | No | A label for the credential. |
namespace | string · body | No | The namespace of the credential. A session uses the credentials of its own namespace.Default "default". |
projectId | string (uuid) · body | No | The project to store the credential in. Required with an organization key. |
The response is 201:
Response
| Field | Type | Description |
|---|---|---|
origin | string | The website origin of the credential. |
namespace | string | The namespace of the credential. |
label | string | The label of the credential. |
createdAt | string (date-time) | When the credential was created. |
updatedAt | string (date-time) | When the credential last changed. |
See Credentials.
curl -X POST https://api.steel.dev/v1/credentials \
-H "steel-api-key: $STEEL_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"origin\": \"https://app.example.com\", \"value\": {\"username\": \"user@example.com\", \"password\": \"$SITE_PASSWORD\"}}"import Steel from "steel-sdk";
const client = new Steel();
const credential = await client.credentials.create({
origin: "https://app.example.com",
value: {
username: "user@example.com",
password: process.env.SITE_PASSWORD!,
},
});
console.log(credential.origin, credential.namespace);import os
from steel import Steel
client = Steel()
credential = client.credentials.create(
origin="https://app.example.com",
value={
"username": "user@example.com",
"password": os.environ["SITE_PASSWORD"],
},
)
print(credential.origin, credential.namespace)package main
import (
"context"
"fmt"
"log"
"os"
"github.com/steel-dev/sdk/go"
)
func main() {
if err := run(context.Background()); err != nil {
log.Fatal(err)
}
}
func run(ctx context.Context) error {
client := steel.NewClient()
credential, err := client.Credentials.New(ctx, steel.CredentialNewParams{
Origin: steel.F("https://app.example.com"),
Value: steel.F(map[string]string{
"username": "user@example.com",
"password": os.Getenv("SITE_PASSWORD"),
}),
})
if err != nil {
return err
}
fmt.Println(credential.Origin, credential.Namespace)
return nil
}#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = steel_rs::Client::new();
let credential = client
.credentials()
.create(steel_rs::CredentialCreateParams {
origin: Some("https://app.example.com".to_owned()),
..steel_rs::CredentialCreateParams::new(std::collections::HashMap::from([
("username".to_owned(), "user@example.com".to_owned()),
("password".to_owned(), std::env::var("SITE_PASSWORD")?),
]))
})
.await?;
let origin = credential.origin.unwrap_or_default();
let namespace = credential.namespace.unwrap_or_default();
println!("{origin} {namespace}");
Ok(())
}List credentials
GET/v1/credentials
Lists the stored credentials of one namespace. The response holds their metadata, never their values.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string (uuid) · query | No | The project whose credentials to list. Required with an organization key. |
namespace | string · query | No | The namespace whose credentials to list. The response never holds other namespaces.Default "default". |
origin | string · query | No | The origin whose credentials to list. |
Response
| Field | Type | Description |
|---|---|---|
credentials | object[] | The credentials, each with origin, namespace, label, createdAt and updatedAt. |
See Credentials.
curl https://api.steel.dev/v1/credentials \
-H "steel-api-key: $STEEL_API_KEY"const { credentials } = await client.credentials.list();
for (const credential of credentials) {
console.log(credential.origin, credential.namespace);
}result = client.credentials.list()
for credential in result.credentials:
print(credential.origin, credential.namespace)result, err := client.Credentials.List(ctx, steel.CredentialListParams{})
if err != nil {
return err
}
for _, credential := range result.Credentials {
fmt.Println(credential.Origin, credential.Namespace)
}let result = client
.credentials()
.list(steel_rs::CredentialListParams::default())
.await?;
for credential in result.credentials {
let origin = credential.origin.unwrap_or_default();
let namespace = credential.namespace.unwrap_or_default();
println!("{origin} {namespace}");
}Update a credential
PUT/v1/credentials
Encrypts and stores new values for the credential of one origin.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
origin | string · body | No | The website origin of the credential. |
value | object · body | No | The new credential, as string fields. |
label | string · body | No | A new label. |
namespace | string · body | No | The namespace of the credential.Default "default". |
projectId | string (uuid) · body | No | The credential's project. Required with an organization key. |
The response has the fields in Store a credential.
See Credentials.
curl -X PUT https://api.steel.dev/v1/credentials \
-H "steel-api-key: $STEEL_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"origin\": \"https://app.example.com\", \"value\": {\"username\": \"user@example.com\", \"password\": \"$SITE_PASSWORD\"}}"await client.credentials.update({
origin: "https://app.example.com",
value: {
username: "user@example.com",
password: process.env.SITE_PASSWORD!,
},
});client.credentials.update(
origin="https://app.example.com",
value={
"username": "user@example.com",
"password": os.environ["SITE_PASSWORD"],
},
)import "os"
if _, err := client.Credentials.Update(ctx, steel.CredentialUpdateParams{
Origin: steel.F("https://app.example.com"),
Value: steel.F(map[string]string{
"username": "user@example.com",
"password": os.Getenv("SITE_PASSWORD"),
}),
}); err != nil {
return err
}client
.credentials()
.update(steel_rs::CredentialUpdateParams {
origin: Some("https://app.example.com".to_owned()),
value: Some(std::collections::HashMap::from([
("username".to_owned(), "user@example.com".to_owned()),
("password".to_owned(), std::env::var("SITE_PASSWORD")?),
])),
..Default::default()
})
.await?;Delete a credential
DELETE/v1/credentials
Deletes the credential of one origin.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
origin | string · body | Yes | The website origin of the credential. |
namespace | string · body | No | The namespace of the credential.Default "default". |
projectId | string (uuid) · body | No | The project to delete the credential from. Required with an organization key. |
Response
| Field | Type | Description |
|---|---|---|
success | boolean | Whether the credential was deleted. |
See Credentials.
curl -X DELETE https://api.steel.dev/v1/credentials \
-H "steel-api-key: $STEEL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"origin": "https://app.example.com"}'const result = await client.credentials.delete({
origin: "https://app.example.com",
});
console.log(result.success);result = client.credentials.delete(origin="https://app.example.com")
print(result.success)result, err := client.Credentials.Delete(ctx, steel.CredentialDeleteParams{
Origin: steel.F("https://app.example.com"),
})
if err != nil {
return err
}
fmt.Println(result.Success)let result = client
.credentials()
.delete(steel_rs::CredentialDeleteParams::new(
"https://app.example.com".to_owned(),
))
.await?;
println!("{}", result.success);