@spec scim(dsl_or_extended :: module() | map()) :: [struct()]

scim DSL entities

@spec scim_create_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The Ash create action used by SCIM POST requests. Defaults to the resource's primary create action.

@spec scim_create_action!(dsl_or_extended :: module() | map()) :: atom() | no_return()

The Ash create action used by SCIM POST requests. Defaults to the resource's primary create action.

@spec scim_destroy_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The Ash destroy action used by SCIM DELETE requests. Defaults to the resource's primary destroy action.

@spec scim_destroy_action!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The Ash destroy action used by SCIM DELETE requests. Defaults to the resource's primary destroy action.

@spec scim_extension_urns(module()) :: [String.t()]

Returns the declared SCIM schema-extension URNs for resource.

@spec scim_mappings(module()) :: [
  AshScim.Dsl.Map.t()
  | AshScim.Dsl.Complex.t()
  | AshScim.Dsl.Multivalued.t()
  | AshScim.Dsl.Extension.t()
]

Returns all SCIM mapping entities (maps, complex, multivalued) declared on the resource, preserving declaration order.

@spec scim_meta?(dsl_or_extended :: module() | map()) :: boolean()

Emit the standard SCIM meta object (created, lastModified, location, resourceType).

@spec scim_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

scim DSL options

Returns a map containing the and any configured or default values.

@spec scim_path(dsl_or_extended :: module() | map()) :: {:ok, String.t()} | :error

URL path under which this resource is mounted (relative to the SCIM root).

@spec scim_path!(dsl_or_extended :: module() | map()) :: String.t() | no_return()

URL path under which this resource is mounted (relative to the SCIM root).

@spec scim_read_action(dsl_or_extended :: module() | map()) :: {:ok, atom()} | :error

The Ash read action used by SCIM GET requests. Defaults to the resource's primary read action.

@spec scim_read_action!(dsl_or_extended :: module() | map()) :: atom() | no_return()

The Ash read action used by SCIM GET requests. Defaults to the resource's primary read action.

@spec scim_resource?(module()) :: boolean()

Returns true if resource carries either the AshScim.User or AshScim.Group extension.

@spec scim_schema(dsl_or_extended :: module() | map()) :: {:ok, String.t()} | :error

The SCIM schemas URN advertised for this resource.

@spec scim_schema!(dsl_or_extended :: module() | map()) :: String.t() | no_return()

The SCIM schemas URN advertised for this resource.

@spec scim_type(module()) :: :user | :group | nil

Returns the SCIM resource type for resource — :user, :group, or nil.

@spec scim_update_action(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The Ash update action used by SCIM PUT/PATCH requests. Defaults to the resource's primary update action.

@spec scim_update_action!(dsl_or_extended :: module() | map()) :: atom() | no_return()

The Ash update action used by SCIM PUT/PATCH requests. Defaults to the resource's primary update action.