Creates a new for a specified .
Copy POST /acs/credentials/create ⇒ { acs_credential }
Authentication MethodsPersonal access token
Must also include the seam-workspace
header in the request.
To learn more, see .
Request Parameters
access_method
String (Required)
Access method for the new credential. Supported values: code
, card
, mobile_key
.
acs_system_id
String
ID of the access system to which the new credential belongs. You must provide either acs_user_id
or the combination of user_identity_id
and acs_system_id
.
acs_user_id
String
ID of the access system user to whom the new credential belongs. You must provide either acs_user_id
or the combination of user_identity_id
and acs_system_id
.
allowed_acs_entrance_ids
Array of UUIDs
assa_abloy_vostio_metadata
Object
Vostio-specific metadata for the new credential.
code
String
credential_manager_acs_system_id
String
ACS system ID of the credential manager for the new credential.
ends_at
String
is_multi_phone_sync_credential
Boolean
salto_space_metadata
Object
Salto Space-specific metadata for the new credential.
starts_at
String
user_identity_id
String
ID of the user identity to whom the new credential belongs. You must provide either acs_user_id
or the combination of user_identity_id
and acs_system_id
. If the access system contains a user with the same email_address
or phone_number
as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.
visionline_metadata
Object
Visionline-specific metadata for the new credential.
Response
Copy {
JSON representation of acs_credential
}
Examples
Create a credential for an ACS user
Specify the acs_user_id
and access_method
to create a new credential. You can also specify additional parameters, depending on the access_method
.
Code
Copy await seam.acs.credentials.create({
acs_user_id: "33333333-3333-3333-3333-333333333333",
access_method: "mobile_key",
allowed_acs_entrance_ids: [
"55555555-5555-5555-5555-555555555555",
"55555555-5555-5555-5555-000000000000",
],
credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888",
is_multi_phone_sync_credential: true,
starts_at: "2024-03-01T10:40:00Z",
ends_at: "2024-03-04T10:40:00Z",
});
Output
Copy {
"acs_credential_id": "99999999-9999-9999-9999-999999999999",
"acs_user_id": "33333333-3333-3333-3333-333333333333",
"display_name": "Multi Phone Sync Credential",
"code": null,
"acs_system_id": "88888888-8888-8888-8888-888888888888",
"access_method": "mobile_key",
"workspace_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-04-12T03:56:22.396Z",
"is_multi_phone_sync_credential": true
}
Code
Copy seam.acs.credentials.create(
acs_user_id="33333333-3333-3333-3333-333333333333",
access_method="mobile_key",
allowed_acs_entrance_ids=[
"55555555-5555-5555-5555-555555555555",
"55555555-5555-5555-5555-000000000000",
],
credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888",
is_multi_phone_sync_credential=true,
starts_at="2024-03-01T10:40:00Z",
ends_at="2024-03-04T10:40:00Z",
)
Output
Copy AcsCredential(
acs_credential_id="99999999-9999-9999-9999-999999999999",
acs_user_id="33333333-3333-3333-3333-333333333333",
display_name="Multi Phone Sync Credential",
code=None,
acs_system_id="88888888-8888-8888-8888-888888888888",
access_method="mobile_key",
workspace_id="00000000-0000-0000-0000-000000000000",
created_at="2024-04-12T03:56:22.396Z",
is_multi_phone_sync_credential=true,
)
Code
Copy seam.acs.credentials.create(
acs_user_id: "33333333-3333-3333-3333-333333333333",
access_method: "mobile_key",
allowed_acs_entrance_ids: %w[
55555555-5555-5555-5555-555555555555
55555555-5555-5555-5555-000000000000
],
credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888",
is_multi_phone_sync_credential: true,
starts_at: "2024-03-01T10:40:00Z",
ends_at: "2024-03-04T10:40:00Z",
)
Output
Copy {
"acs_credential_id" => "99999999-9999-9999-9999-999999999999",
"acs_user_id" => "33333333-3333-3333-3333-333333333333",
"display_name" => "Multi Phone Sync Credential",
"code" => nil,
"acs_system_id" => "88888888-8888-8888-8888-888888888888",
"access_method" => "mobile_key",
"workspace_id" => "00000000-0000-0000-0000-000000000000",
"created_at" => "2024-04-12T03:56:22.396Z",
"is_multi_phone_sync_credential" => true,
}
Code
Copy <?php
$seam->acs->credentials->create(
acs_user_id: "33333333-3333-3333-3333-333333333333",
access_method: "mobile_key",
allowed_acs_entrance_ids: [
"55555555-5555-5555-5555-555555555555",
"55555555-5555-5555-5555-000000000000",
],
credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888",
is_multi_phone_sync_credential: true,
starts_at: "2024-03-01T10:40:00Z",
ends_at: "2024-03-04T10:40:00Z"
);
Output
Copy <?php
[
"acs_credential_id" => "99999999-9999-9999-9999-999999999999",
"acs_user_id" => "33333333-3333-3333-3333-333333333333",
"display_name" => "Multi Phone Sync Credential",
"code" => null,
"acs_system_id" => "88888888-8888-8888-8888-888888888888",
"access_method" => "mobile_key",
"workspace_id" => "00000000-0000-0000-0000-000000000000",
"created_at" => "2024-04-12T03:56:22.396Z",
"is_multi_phone_sync_credential" => true,
];
Code
Copy seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z"
Output
Copy {
"acs_credential_id": "99999999-9999-9999-9999-999999999999",
"acs_user_id": "33333333-3333-3333-3333-333333333333",
"display_name": "Multi Phone Sync Credential",
"code": null,
"acs_system_id": "88888888-8888-8888-8888-888888888888",
"access_method": "mobile_key",
"workspace_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-04-12T03:56:22.396Z",
"is_multi_phone_sync_credential": true
}
Code
Copy package main
import api "github.com/seamapi/go"
import credentials "github.com/seamapi/go/credentials"
func main() {
client.Acs.Credentials.Create(
context.Background(),
credentials.CredentialsCreateRequest{
AcsUserId: api.String("33333333-3333-3333-3333-333333333333"),
AccessMethod: api.String("mobile_key"),
AllowedAcsEntranceIds: [2]string{api.String("55555555-5555-5555-5555-555555555555"), api.String("55555555-5555-5555-5555-000000000000")},
CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"),
IsMultiPhoneSyncCredential: api.Bool(true),
StartsAt: api.String("2024-03-01T10:40:00Z"),
EndsAt: api.String("2024-03-04T10:40:00Z"),
},
)
}
Output
Copy api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}
Code
Copy curl --include --request POST "https://connect.getseam.com/acs/credentials/create" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"acs_user_id": "33333333-3333-3333-3333-333333333333",
"access_method": "mobile_key",
"allowed_acs_entrance_ids": [
"55555555-5555-5555-5555-555555555555",
"55555555-5555-5555-5555-000000000000"
],
"credential_manager_acs_system_id": "88888888-8888-8888-8888-888888888888",
"is_multi_phone_sync_credential": true,
"starts_at": "2024-03-01T10:40:00Z",
"ends_at": "2024-03-04T10:40:00Z"
}
EOF
Output
Copy {
"acs_credential": {
"acs_credential_id": "99999999-9999-9999-9999-999999999999",
"acs_user_id": "33333333-3333-3333-3333-333333333333",
"display_name": "Multi Phone Sync Credential",
"code": null,
"acs_system_id": "88888888-8888-8888-8888-888888888888",
"access_method": "mobile_key",
"workspace_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-04-12T03:56:22.396Z",
"is_multi_phone_sync_credential": true
}
}