Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Sign-In Service Client Configuration and Documentation #184

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Sign-In Service Client Configuration and Documentation #184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,30 @@ Currently, SignInService is available as a part of `vets-api`
git clone [email protected]:department-of-veterans-affairs/vets-api.git
```
2. Follow [setup instructions]([email protected]:department-of-veterans-affairs/vets-api.git) for vets-api
3. Ensure your database is prpoerly seeded `rails db:seed` this will add the necessary client configurations
3. Ensure your database is properly seeded `rails db:seed` this will add the necessary client configurations

### Creating a New Client Configuration
If you need to create a new client configuration in vets-api:

```ruby
# In vets-api rails console
client = SignIn::ClientConfig.create!(
client_id: 'sample_client_api',
authentication: 'api',
pkce: true,
redirect_uri: 'http://localhost:4567/auth/callback',
access_token_duration: 300,
refresh_token_duration: 1800,
access_token_audience: 'va.gov',
anti_csrf: true,
shared_sessions: true,
service_levels: ['ial2'],
access_token_attributes: ['first_name', 'last_name', 'email'],
description: 'Sign In Service Example Client',
logout_redirect_uri: 'http://localhost:4567/',
credential_service_providers: ['idme', 'logingov']
)
```

### Configure the SignInService client
This application uses the [SignInService Ruby Client](docs/sign_in_service_ruby_client.md)
Expand Down Expand Up @@ -53,7 +75,6 @@ the correct client and auth_type.
vets-api % rails s
```


## Running the Example app
### Native
Setup the app:
Expand Down
Loading