Authorization
Authentication and Authorization Service
Operations
POST
# Create a new client for a specific organization
GET
# Get organization OAuth client
GET
# Get organization OAuth client
PUT
# Update Specific Oauth client of organization
DEL
# Delete Organization OAuth client
Use this Api to create a new client for an organization
Parameters
organization_id
string
Required
The unique identifier for the organization.
Request body
scopes
object (ClientScopes)
ClientScopes
type
string
The type of the scope.
permissions
array of string
List of permissions for the scope.
grants
array of string
List of grants for the client.
meta
object (ClientMeta)
ClientMeta
tags
array of string
Tags associated with the client.
name
string
Name of the client.
description
string
Description of the client.
user_id
string
ID of the user associated with the client.
Response
201
Client successfully created
ClientResponseSchema
company_id
number
The ID of the company associated with the client.
client_id
string
The unique identifier for the client.
secret
array of string
List of secrets associated with the client.
slug
string
Slug for the client.
scopes
object (ClientScopes)
ClientScopes
type
string
The type of the scope.
permissions
array of string
List of permissions for the scope.
grants
array of string
List of grants for the client.
redirect_urls
array of string
List of redirect URLs for the client.
access_token_lifetime
integer
Lifetime of the access token in seconds.
refresh_token_lifetime
integer
Lifetime of the refresh token in seconds.
meta
object (ClientMeta)
ClientMeta
tags
array of string
Tags associated with the client.
name
string
Name of the client.
description
string
Description of the client.
user_id
string
ID of the user associated with the client.
author
object
Author information related to the client.
is_active
boolean
wheather the client is active or not
client_type
string
Type of the client.
Enum
organization_id
string
ID of the organization associated with the client.
_id
string
Unique identifier for the client.
created_at
string
| date-time
Timestamp when the client was created.
modified_at
string
| date-time
Timestamp when the client was last modified.
raw_permissions
array of string
List of raw permissions associated with the client.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
organization_id:
"669f54a60ebf12eabcbf4f33"
body:
body
Was this section helpful?
POST
1curl -X POST "https://api.fynd.com/service/partner/authorization/v1.0/organization/{organization_id}/oauth/client"2 -H 'Authorization: Bearer {authorization_token}'3 -H 'Content-Type: application/json'4-d '{5 "scopes": {6 "type": "all",7 "permissions": [8 "organization/*"9 ]10 },11 "grants": [12 "client_credentials"13 ],14 "meta": {15 "tags": [],16 "name": "TestClientTest",17 "description": "NA"18 }19}'
Response
Example not available.
Parameters
organization_id
string
Required
The ID of the organization
page_no
integer
Page number for pagination
page_size
integer
Number of items per page
is_active
boolean
wheather to filter by active status or not
Response
200
Client List Fetched Succesfully
ClientListSchema
items
array of object (ClientResponseSchema)
List of client responses.
Array of ClientResponseSchema
company_id
number
The ID of the company associated with the client.
client_id
string
The unique identifier for the client.
secret
array of string
List of secrets associated with the client.
slug
string
Slug for the client.
scopes
object (ClientScopes)
ClientScopes
type
string
The type of the scope.
permissions
array of string
List of permissions for the scope.
grants
array of string
List of grants for the client.
redirect_urls
array of string
List of redirect URLs for the client.
access_token_lifetime
integer
Lifetime of the access token in seconds.
refresh_token_lifetime
integer
Lifetime of the refresh token in seconds.
meta
object (ClientMeta)
ClientMeta
tags
array of string
Tags associated with the client.
name
string
Name of the client.
description
string
Description of the client.
user_id
string
ID of the user associated with the client.
author
object
Author information related to the client.
is_active
boolean
wheather the client is active or not
client_type
string
Type of the client.
Enum
organization_id
string
ID of the organization associated with the client.
_id
string
Unique identifier for the client.
created_at
string
| date-time
Timestamp when the client was created.
modified_at
string
| date-time
Timestamp when the client was last modified.
raw_permissions
array of string
List of raw permissions associated with the client.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
organization_id:
"669f54a60ebf12eabcbf4f33"
page_no:
1
page_size:
20
is_active:
true
Was this section helpful?
GET
1curl -X GET "https://api.fynd.com/service/partner/authorization/v1.0/organization/{organization_id}/oauth/client"2 -H 'Authorization: Bearer {authorization_token}'
Response
Example not available.
Parameters
organization_id
string
Required
The ID of the organization
client_id
string
Required
The ID of the client
Response
200
Client List Fetched Succesfully
ClientResponseSchema
company_id
number
The ID of the company associated with the client.
client_id
string
The unique identifier for the client.
secret
array of string
List of secrets associated with the client.
slug
string
Slug for the client.
scopes
object (ClientScopes)
ClientScopes
type
string
The type of the scope.
permissions
array of string
List of permissions for the scope.
grants
array of string
List of grants for the client.
redirect_urls
array of string
List of redirect URLs for the client.
access_token_lifetime
integer
Lifetime of the access token in seconds.
refresh_token_lifetime
integer
Lifetime of the refresh token in seconds.
meta
object (ClientMeta)
ClientMeta
tags
array of string
Tags associated with the client.
name
string
Name of the client.
description
string
Description of the client.
user_id
string
ID of the user associated with the client.
author
object
Author information related to the client.
is_active
boolean
wheather the client is active or not
client_type
string
Type of the client.
Enum
organization_id
string
ID of the organization associated with the client.
_id
string
Unique identifier for the client.
created_at
string
| date-time
Timestamp when the client was created.
modified_at
string
| date-time
Timestamp when the client was last modified.
raw_permissions
array of string
List of raw permissions associated with the client.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
organization_id:
"66b071bdaf6a7429fe364d99"
client_id:
"66ae252f8a93bd884161a441"
Was this section helpful?
GET
1curl -X GET "https://api.fynd.com/service/partner/authorization/v1.0/organization/{organization_id}/oauth/client/{client_id}"2 -H 'Authorization: Bearer {authorization_token}'
Response
Example not available.
Use this Api to Update OAuth Client name and tags description
Parameters
organization_id
string
Required
The unique identifier for the organization.
client_id
string
Required
The ID of the client
Request body
meta
object (ClientMeta)
ClientMeta
tags
array of string
Tags associated with the client.
name
string
Name of the client.
description
string
Description of the client.
user_id
string
ID of the user associated with the client.
Response
200
Client updated successfully
ClientResponseSchema
company_id
number
The ID of the company associated with the client.
client_id
string
The unique identifier for the client.
secret
array of string
List of secrets associated with the client.
slug
string
Slug for the client.
scopes
object (ClientScopes)
ClientScopes
type
string
The type of the scope.
permissions
array of string
List of permissions for the scope.
grants
array of string
List of grants for the client.
redirect_urls
array of string
List of redirect URLs for the client.
access_token_lifetime
integer
Lifetime of the access token in seconds.
refresh_token_lifetime
integer
Lifetime of the refresh token in seconds.
meta
object (ClientMeta)
ClientMeta
tags
array of string
Tags associated with the client.
name
string
Name of the client.
description
string
Description of the client.
user_id
string
ID of the user associated with the client.
author
object
Author information related to the client.
is_active
boolean
wheather the client is active or not
client_type
string
Type of the client.
Enum
organization_id
string
ID of the organization associated with the client.
_id
string
Unique identifier for the client.
created_at
string
| date-time
Timestamp when the client was created.
modified_at
string
| date-time
Timestamp when the client was last modified.
raw_permissions
array of string
List of raw permissions associated with the client.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
organization_id:
"66b071bdaf6a7429fe364d99"
client_id:
"66ae252f8a93bd884161a441"
body:
body
Was this section helpful?
PUT
1curl -X PUT "https://api.fynd.com/service/partner/authorization/v1.0/organization/{organization_id}/oauth/client/{client_id}"2 -H 'Authorization: Bearer {authorization_token}'3 -H 'Content-Type: application/json'4-d '{5 "meta": {6 "tags": [7 "name"8 ],9 "name": "TestClientTest",10 "description": "NA"11 }12}'
Response
Example not available.
This endpoint allows you to delete a specific Organization OAuth client.
Parameters
organization_id
string
Required
ID of the organization
client_id
string
Required
ID of the OAuth client
Response
200
Client deleted successfully
ClientResponseSchema
company_id
number
The ID of the company associated with the client.
client_id
string
The unique identifier for the client.
secret
array of string
List of secrets associated with the client.
slug
string
Slug for the client.
scopes
object (ClientScopes)
ClientScopes
type
string
The type of the scope.
permissions
array of string
List of permissions for the scope.
grants
array of string
List of grants for the client.
redirect_urls
array of string
List of redirect URLs for the client.
access_token_lifetime
integer
Lifetime of the access token in seconds.
refresh_token_lifetime
integer
Lifetime of the refresh token in seconds.
meta
object (ClientMeta)
ClientMeta
tags
array of string
Tags associated with the client.
name
string
Name of the client.
description
string
Description of the client.
user_id
string
ID of the user associated with the client.
author
object
Author information related to the client.
is_active
boolean
wheather the client is active or not
client_type
string
Type of the client.
Enum
organization_id
string
ID of the organization associated with the client.
_id
string
Unique identifier for the client.
created_at
string
| date-time
Timestamp when the client was created.
modified_at
string
| date-time
Timestamp when the client was last modified.
raw_permissions
array of string
List of raw permissions associated with the client.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
organization_id:
"66b071bdaf6a7429fe364d99"
client_id:
"66ae252f8a93bd884161a441"
Was this section helpful?
DEL
1curl -X DELETE "https://api.fynd.com/service/partner/authorization/v1.0/organization/{organization_id}/oauth/client/{client_id}"2 -H 'Authorization: Bearer {authorization_token}'
Response
Example not available.