Skip to content

Commit 0a324fd

Browse files
Update README.md
1 parent 3d0d76c commit 0a324fd

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -963,12 +963,21 @@ end
963963
964964
The `attribute_value` option additionally accepts an array of possible values.
965965
966-
## SP Request UUIDs
966+
## SP-Originated Message IDs
967967
968968
By default, Ruby SAML will generate UUIDs for SP requests prefixed with the `_` character,
969969
for example `"_ea8b5fdf-0a71-4bef-9f87-5406ee746f5b"`. To override this behavior,
970970
you may set `settings.sp_uuid_prefix` to a string of your choice, or `false` to use no prefix.
971971
972+
## SP-Originated Message IDs
973+
974+
Ruby SAML automatically generates message IDs for SP-originated messages (AuthNRequest, etc.)
975+
By default, this is a UUID prefixed by the `_` character, for example `"_ea8b5fdf-0a71-4bef-9f87-5406ee746f5b"`.
976+
To override this behavior, you may set `settings.sp_uuid_prefix` to a string of your choice.
977+
Note that the SAML specification requires that this type (`xsd:ID`) be an
978+
[NCName](https://www.w3.org/TR/xmlschema-2/#NCName), meaning that it must start with a letter
979+
or underscore, and can only contain letters, digits, underscores, hyphens, and periods.
980+
972981
## Custom Metadata Fields
973982
974983
Some IdPs may require to add SPs to add additional fields (Organization, ContactPerson, etc.)

0 commit comments

Comments
 (0)