access-groups

Changed on

Creates an access group

post/v1/access-groups

Request

  • Base URL
    https://api.scalar.com/core
  • URL
    https://api.scalar.com/core/v1/access-groups
  • Auth
    HTTP bearer

Request body

namestring
slugstring
allowedDomainsunknown
allowedEmailsunknown

Example request

{
  "name": "Engineering",
  "slug": "acme-api"
}

Response

Default Response

uidstring required
createdAtinteger required
updatedAtinteger required
namestring required
slugstring required
allowedEmailsunknown required
allowedDomainsunknown required

Example response

{
  "uid": "UakgbKJ5m9gl0JDMbcJqL",
  "createdAt": 1735689600,
  "updatedAt": 1735689600,
  "name": "Engineering",
  "slug": "acme-api",
  "allowedEmails": [
    "alex@example.com"
  ],
  "allowedDomains": [
    "example.com"
  ]
}

Changes

  • 5e4c47d6805bRevision changes
    • info

      the response's property default value unixTimestamp() was removed for the status

    • info

      the response's property default value randomAccessGroupSlug() was removed for the status

    • info

      the response's property default value nanoid() was removed for the status

    • info

      the response's property default value unixTimestamp() was removed for the status

  • 8dff1e93bc68Revision changes
    • info

      api operation id postv1AccessGroups removed and replaced with postV1AccessGroups