Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
johnnyshields authored Jan 15, 2025
1 parent 3d0d76c commit 0a324fd
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -963,12 +963,21 @@ end
The `attribute_value` option additionally accepts an array of possible values.
## SP Request UUIDs
## SP-Originated Message IDs
By default, Ruby SAML will generate UUIDs for SP requests prefixed with the `_` character,
for example `"_ea8b5fdf-0a71-4bef-9f87-5406ee746f5b"`. To override this behavior,
you may set `settings.sp_uuid_prefix` to a string of your choice, or `false` to use no prefix.
## SP-Originated Message IDs
Ruby SAML automatically generates message IDs for SP-originated messages (AuthNRequest, etc.)
By default, this is a UUID prefixed by the `_` character, for example `"_ea8b5fdf-0a71-4bef-9f87-5406ee746f5b"`.
To override this behavior, you may set `settings.sp_uuid_prefix` to a string of your choice.
Note that the SAML specification requires that this type (`xsd:ID`) be an
[NCName](https://www.w3.org/TR/xmlschema-2/#NCName), meaning that it must start with a letter
or underscore, and can only contain letters, digits, underscores, hyphens, and periods.
## Custom Metadata Fields
Some IdPs may require to add SPs to add additional fields (Organization, ContactPerson, etc.)
Expand Down

0 comments on commit 0a324fd

Please sign in to comment.